一、代码格式

在编写代码的过程中,代码格式方面建议遵守一下规则。
(1)通常情况下,代码缩进为4个空格,这是Visual Studio 2005的默认设置。
(2)在代码中垂直对齐同一层次的左括号和右括号。
(3)为了防止在阅读代码时左右滚动源代码编辑器,每行代码或注释不得超过一个显示屏。
(4)当一行被分为几行时,需要将串联运算符放在每一行的末尾。
(5)每一行上放置的语句避免超过一条。
(6)在大多数运算符之前和之后使用空格,这样做是不会改变代码意图的,却可以使代码更加容易阅读。
(7)将大的复杂代码节分为较小的、易于理解的模块。
(8)编写SQL语句时,关键字全部使用大写,数据库元素(如表、列和视图)使用大小写混合。
(9)将每个主要的SQL子句放在不同的行上,这样更容易阅读和编辑语句。
  示例代码如下:
  SELECT FirstName,LastName
  FROM Customers
  WHERE State = ‘CHN’

二、注释规范

注释规范包括:源文件注释规范、类注释规范、类的属性和方法注释规范、代码间注释。

1。源文件注释规范
建议的源文件头部注释示例如下所示。
/*****************************************************
** 文 件 名:
** Copyright (c) 2005-2006 ********软件项目开发部门
** 文件编号:
** 创 建 人:
** 日 期:
** 修 改 人:
** 日 期:
** 描 述:
********************************************************/

2。类注释规范
类开始部分必须以如下形式书写注释。
/**********************************************************
** 类 编 号:<类编号可以引用系统设计中的类编号>
** 作 用:<对此类的描述,可以引用系统设计中的描述>
** 作 者:作者中文名
** 编写日期:<类创建口期,格式:YYYY-MM-DD>
**********************************************************/

3。类属性注释规范

在类的属性前必须以如下格式编写属性注释。
//
//属性说明
//

4、方法注释规范

在类的方法声明前必须以如下格式编写注释。
/*****************************************************
** 函 数 名:
** 功能描述:
** 输入参数:a - 类型 <说明>
** b - 类型 <说明>
** 输出参数:x - 类型 <说明>
** 返 回 值:- 类型 <说明>
** 作 者:作者中文名
** 日 期:
** 修 改 人:<修改人>
** 日 期:
********************************************************/

5。代码间注释规范

代码间注释应遵从以下规范。
//
//<注释>
//
代码中遇到语句块时,例如,if,for,foreach必须添加注释。添加的注释要能够说明此语句块的作用和实现手段。

三、类命名规范

(1)名字应该能够标识事物的特性。
(2)名字尽量不使用缩写,除非是众所周知的。
(3)名字可以由两个或三个单词组成,通常不应多于三个。
(4)在名字中,所有单词第一个字母大写。
(5)使用名词或名词短语命名类。
(6)少用缩写。
(7)不要使用下划线字符(_)。

四、接口命名规范

和类命名规范相同,唯一区别是接口在名字前加上“I”前缀。

五、方法命名规范

和类命名规范相同。

六、名字空间命名规范

和类命名规范相同。

七、程序版本号确定规范

主程序的版本号由主版本号十次版本号+Build(Fix版本号)构成。主版本号表示程序的重大修改,例如,修改或改进了程序的重要功能。次版本号表示程序的一般修改,例如,修改或了程序的一般功能。Fix议版本号表示程序Bug的修改,以修改的日期缩写表示,如2006-8-20修改的Fix版本号就是20060820。举例说明,程序版本号为1.2bulid(2060820),表示该程序的主号是1,次版本号为2,Fix版本号为20060820。

转载于:https://www.cnblogs.com/jRoger/articles/1833536.html

c#编码规范【转载】相关推荐

  1. 浅谈 JavaScript 编程语言的编码规范--转载

    原文:http://www.ibm.com/developerworks/cn/web/1008_wangdd_jscodingrule/ 对于熟悉 C/C++ 或 Java 语言的工程师来说,Jav ...

  2. [转载] Python pep8编码规范

    参考链接: PEP 8:Python中的编码样式指南 原文链接:http://legacy.python.org/dev/peps/pep-0008/ itemdetailPEP8TitleStyle ...

  3. 【转载】Uber Go语言编码规范

    文章目录 Uber Go语言编码规范 一. 介绍 二. 指导原则 指向interface的指针 接收器(receiver)与接口 零值Mutex是有效的 在边界处拷贝Slices和Maps 接收Sli ...

  4. JavaScript最全编码规范

    转载: JavaScript最全编码规范 类型 ●基本类型:访问基本类型时,应该直接操作类型值 ●string ●number ●boolean ●null ●undefined var foo = ...

  5. Python最简编码规范

    0.前言 本文是阅读<Python Coding Rule>之后总结的最为精华及简单的编码规范,根据每个人不同喜好有些地方会有不同的选择,我只是做了对自己来说最简单易行的选择,仅供大家参考 ...

  6. PHP标记风格,编码规范

    PHP标记风格 PHP一共支持4种标记风格 <?php echo "这是XML风格的标记"; ?> 脚本风格 <script language="php ...

  7. 人人FED CSS编码规范

    完整PDF下载链接:<人人FED CSS编码规范> 浏览器特效支持规范 为了页面性能考虑,如果浏览器不支持CSS3相关属性的,则该浏览器的某些特效将不再支持,属性的支持情况如下表所示:   ...

  8. 【浙大网新图灵通讯】无废话简单高效C#编码规范20100611

    无废话简单高效C#编码规范20100611   自己看自己的代码啥问题也没有,但是一个团队.N多个人.N多年的代码,就比较难维护.难阅读了,什么样的不好的习惯.错误漏洞能出来的就全出来了. 第1章   ...

  9. 【转】Android编码规范建议18条

    转自:http://www.chinaz.com/design/2015/0908/443732.shtml Android编码规范建议18条 适合手机app设计师和android 工程师阅读. 1. ...

  10. Objective-C 编码规范

    Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程 ...

最新文章

  1. List元素互换,List元素转换下标,Java Collections.swap()方法实例解析
  2. htpc电脑方案_我终于定稿了客厅HTPC的方案: Matx机箱小喆B3卧倒
  3. redis List的用途及常用命令
  4. 【Git、GitHub、GitLab】五 git中裸仓库.git下的内容
  5. bootstrap 树形菜单
  6. android 上传nexus_android发布到nexus私服
  7. ubuntu之修改登陆密码
  8. 【Python实例第28讲】核主成分
  9. Lightroom Classic 教程,如何将照片从 Lightroom 移至Ps,在 Ps 中为照片添加文本?
  10. 防火墙放开oracle远程,oracleMTS模式下防火墙如何开通
  11. ic卡识别程序c语言,如何读写接触式IC卡
  12. MySQL下载安装与配置详细教程
  13. 【数据结构课设】家谱管理系统(内附源码)
  14. openpyxl 向excel插入超链接
  15. 前端xlsx导入与导出
  16. python钻石和玻璃球游戏_python使用pygame实现笑脸乒乓球弹珠球游戏
  17. Android自定义View2--触摸事件传递机制
  18. 中位数 POJ3784
  19. C语言中的复制函数(strcpy和memcpy)
  20. QMetaObjectPrivate meta_constractors Q_INVOKABLE

热门文章

  1. 基于Dockerfile构建新镜像
  2. iMX8方案服务-辰汉
  3. CSS中块级格式化上下文(BFC)的特性与应用
  4. NHibernate 错误
  5. MySQL---数据库从入门走向大神系列(十二)-构建MVC项目
  6. CocoStudio资源区导入Plist/PSD文件
  7. 转:Yaf 路由协议
  8. 一小段代码:父类和子类
  9. SpringBoot 修改banner信息
  10. 思科——RIP的运用