【SQL开源代码栏目提醒】:网学会员在SQL开源代码频道为大家收集整理了“C#编码规范 - 编程语言“提供大家参考,希望对大家有所帮助!
最全面的C程序编码规范 一、 目的 为了保证所每个项目组编写出的程序都符合相同的规范便于提高
代码的可读性和可维护性便于检查、减少出错概率有助于项目组成员间交流保证一致性、统一性而建立的C程序编码规范。
二、 范围 该规范适用于所有基于C开发的.Net平台项目为详细设计
代码编写和
代码审核提供参考和依据。
三、 规范内容 1、
代码格式 1.1、要使所有的缩进为一个Tab即4个空格使用VS.NET的默认设置。
1.2、在
代码中垂直对齐左括号和右括号。
if x 0 Response.Write用户编号必须输入 不允许以下情况 if x 0 Response.Write用户编号必须输入 或者 if x 0 Response.Write用户编号必须输入 1.3、为了防止在阅读
代码时滚动源
代码编辑器每行
代码或注释在1024768的分辨率下尽量不超过一显示屏如超过则应换行换行后的
代码应该缩进一个Tab。
1.4、当一行被分为几行时将串联运算符放在每一行的末尾而不是开头清楚地表示没有后面的行是不完整的。
1.5、每一行上放置的语句避免超过一条避免写 int i 0int j 1 1.6、在大多数运算符之前和之后使用空格这样做时不会改变
代码的意图却可以使
代码容易阅读。
例 int j i k 而不应写为 int jik 1.7、将大的复杂
代码节分为较小的、易于理解的模块。
1.8、编写
SQL 语句时建议不强求对于关键字使用全部大写对于数据库元素如表、列和视图使用大小写混合。
1.9、将每个主要的
SQL 子句放在不同的行上这样更容易阅读和编辑语句例如 SELECT FirstName LastName FROM Customers WHERE State WA 2、注释规范 注释是为了增加
代码的清晰度保持注释的简洁不是任何
代码都需要注释的过多的注释反而会影响
代码的可读性。
注释不要包括其他的特殊字符建议先写注释后写
代码注释和
代码一起完成。
如果语句块比如循环和条件分枝的
代码块
代码太长嵌套太多则在其结束“”要加上注释标志对应的开始语句。
如果分支条件逻辑比较复杂也要加上注释。
注释规范主要包括模块类注释规范、类属性注释规范、方法注释规范、
代码间注释规范。
2.1、模块类注释规范 模块开始尽量以以下形式书写模块注释 / 文 件 名: 功能描述 Copyright c 2010-2012 公司技术开发部 创 建 人: 日 期: 修 改 人: 修改日期: 修改描述: 版 本: / 注这里的修改人是指对整个类进行修改过需要在这些添加修改记录且记录累加。
当模块有重大修改或修改他人
代码时必须添加以下注释 / 修 改 人: 日 期: 修改描述 版 本: 修 改 人: 日 期: 修改描述 版 本: / 修改时根据需要保留程序员第一次和最近一次修改的
代码。
具体办法是将原有
代码注释。
保留第一次的
代码可以反映此部分
代码最初要实现的功能及其初始编程思想保留最新的
代码可以反映此
代码最近变化要实现的最新功能 2.2、类属性注释规范 在类的属性必须以以下格式编写属性注释 /// ///属性说明 /// 2.3、方法注释规范 在类的方法声明前必须以以下格式编写注释 /// ///函数的作用 /// /// ///异常类型、异常结果说明为什么产生此异常 在Visual Studio环境中在方法中上一行中输入///开发环境会自动生成注释模板。
例如 region UpgradeThread /// /// 构造函数 /// ///
上一篇:
空间SQL语法分析器的设计实现
下一篇:
论文参考文献写作格式