文档介绍：编码规范 1 规范目的……………………………………………………… 3 2 适用范围……………………………………………………… 3 3 代码注释……………………………………………………… 3 代码注释约定............................................ 3 模块头部注释规范...................................... 3 方法注释规范............................................. 4 代码行注释规范.......................................... 6 变量注释规范............................................. 7 4 命名规则……………………………………………………… 8 命名的基本约定.......................................... 8 各种标示符类型的基本约定......................... 9 组件名称缩写列表....................................... 10 5 其它规范……………………………………………………… 11 编程风格.................................................. 11 资源释放.................................................. 13 错误处理.................................................. 13 其它......................................................... 14 1 规范目的一个软件的生命周期中, 80% 的花费在于维护; 几乎没有任何一个软件, 在其整个生命周期中, 均由最初的开发人员来维护; 编码规范可以改善软件的可读性, 可以让程序员尽快而彻底地理解新的代码。为了执行规范,每个软件开发人员必须一致遵守编码规范; 使用统一编码规范的主要原因, 是使应用程序的结构和编码风格标准化,以便于阅读和理解这段代码; 好的编码约定可使源代码严谨、可读性强且意义清楚, 与其它语言约定相一致,并且尽可能的直观。 2 适用范围本规范主要以 C# 为开发语言的规范,为鲍亮实验室的原则性规范; 由于本规范是为撰写程序而设计, 所以适用于一切有关程序撰写的工作事项。对于具体的每个项目,可能需要对之进行裁剪和补存。适用人员:软件工程专业的学生; 适用产品:以 C# 编写的程序。 3 代码注释 代码注释约定所有的方法和函数都应该以描述这段代码的功能的一段简明注释开始(方法是干什么) 。这种描述不应该包括执行过程细节(它是怎么做的) ,因为这常常是随时间而变的,而且这种描述会导致不必要的注释维护工作, 甚至更糟—成为错误的注释。代码本身和必要的嵌入注释将描述实现方法。当参数的功能不明显且当过程希望参数在一个特定的范围内时, 也应描述传递给过程的参数。被过程改变的函数返回值和全局变量, 特别是通过引用参数的那些,也必须在每个过程的起始处描述它们。 模块头部注释规范以一个物理文件为单元的都需要有模块头部注释规范,例如: C# 文件用于每个模块开头的说明,主要包括: (粗体字为必需部分,其余为可选部分) 文件名称(File Name) : 此文件的名称功能描述(Description) : 此模块的功能描述与大概流程说明数据表(Tables) : 所用到的数据表,视图,存储过程的说明, 如关系比较复杂, 则应说明哪些是可擦写的, 哪些表为只读的。作者(Author) : 日期(Create Date) : 参考文档(Reference)( 可选): 该档所对应的分析文档, 设计文檔。引用(Using) ( 可选)﹕开发的系统中引用其它系统的 Dll 、对象时,要列出其对应的出处,是否与系统有关﹙不清楚的可以不写﹚,以方便制作安装档。修改记录(Revision History) : 若档案的所有者改变, 则需要有修改人员的名字、修改日期及修改理由。分割符: *************************** ( 前后都要) 示例如下: 方法注释规范 1> C# 提供一种机制, 使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中, 具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的