下载文档原格式
软件开发中的编码规范与标准编码规范是指在软件开发过程中，制定一个规范的标准，使得各种不同的程序员在编写代码时，能够遵循同一套规则，从而使得代码的可维护性、可读性、可扩展性更高，更容易维护和防止出现错误。
在软件开发中，编码规范的重要性不言而喻。
一个良好的编码规范可以避免因代码编写不规范而导致的各种问题，比如说代码难以阅读、调试时的错误或性能问题等等。
如果没有编码规范，每个开发者可能会采用自己的风格编程，最终的代码差异会很大，甚至相互冲突。
那么，软件开发中的编码规范和标准应该如何制定呢？以下是一些建议。
第一，编写代码时必须将变量名、函数名、注释等命名规则规范化，必须具有描述性，并且应尽可能短小精悍。
例如，在变量名中使用下划线或驼峰命名法，这符合通用编程规则，并且易于理解和维护。
第二，确保代码排版正确。
在大部分编程语言中，换行和缩进通常用于代码排版。
使用一种固定的排版风格可以使代码更具可读性，减少出错的可能性，并增强代码的可维护性和可扩展性。
第三，要有注释。
注释是代码中记录的重要信息，这些信息可以提高其他开发者的代码阅读能力，加快团队工作进程。
注释要有明确的意思，注释应该描述程序的行为，而不是重复底层操作的代码。
第四，避免编写过于复杂的代码。
过于复杂的代码容易出错并且不易维护，所以应尽量简化代码逻辑。
如果必须编写复杂的代码，应考虑注释、说明、使用设计模式等方式。
第五，定期进行代码评审和验证。
在团队中，评审代码可以促进代码品质的提高，还能够让团队中的每个成员学习到其他人的编程方式。
最后，为新加入开发团队的初学者编写代码规范指南。
为了更好的合作和提升整体开发能力，建议开发团队编写一份通用的代码规范指南，并让所有成员遵循这一标准，使得整个团队可以更高效，更容易理解并维护代码。
编码规范是软件开发中一个至关重要的环节。
良好的编码规范可以减少代码错误，增加代码可读性和可维护性，并让开发团队保持良好的合作关系。
虽然这只是软件开发的一小部分，但它对于软件开发的质量和成功与否起到重要的决定因素。
软件开发中的编码规范在软件开发中，编码规范是一个非常关键的方面。
编码规范可以提高代码质量，降低代码错误率，方便代码维护和交接。
这篇文章将会从多个方面探讨软件开发中的编码规范。
一、命名规范命名规范是编码规范的重要组成部分。
合理的命名规范表明了代码的含义，提高了代码可读性和可维护性。
以下是一些常见的命名规范：1. 类名、接口名使用大写开头的驼峰式命名法，比如SomeClass、MyInterface。
2. 方法名、变量名使用小写开头的驼峰式命名法，比如getSomeData()、myVariable。
3. 常量名使用全大写的下划线命名法，比如 MAX_VALUE、MIN_VALUE。
4. 包名使用小写字母，控制命名空间和组织代码结构。
二、缩进和空格代码的缩进和空格也是编码规范的重要部分。
适当的缩进和空格可以提高代码的可读性。
1. 使用4个空格作为一个单位的缩进，而不是制表符。
2. 在左括号前加一个空格，在右括号后加一个空格，如 if (condition) {。
3. 在二元运算符两边加上一个空格，比如 a = 1 + 2，而不是a=1+2。
三、注释规范注释是代码的重要组成部分，可以帮助其他开发者理解代码的含义。
以下是一些常见的注释规范：1. 类、接口、方法等应该有Javadoc类型的注释，描述它们的作用和参数、返回值等信息。
2. 方法内部的注释应该对复杂算法和思路进行解释和描述。
3. 使用单行注释和多行注释解释代码段的含义和用途。
四、异常处理在软件开发中，异常处理是必要的。
以下是一些异常处理的规范：1. 在try块中捕获异常，并处理它们。
2. 避免捕获不必要的异常，仅处理可能发生的异常。
这可以提高代码的性能和可读性。
3. 使用自定义的异常类来抛出错误，来减少代码中的魔法数字或字符串。
五、代码风格代码的风格应该是一致的，以提高代码的可读性。
以下是一些常见的代码风格规范：1. 按照功能将代码段组织成类和方法，避免代码重复和冗余。
软件开发中的编码规范和代码注释规范软件开发中的编码规范和代码注释规范随着计算机技术的不断发展，软件开发作为一门重要的技术也越来越受到人们的关注。
而在软件开发的过程中，编码规范和代码注释规范是非常重要的一环。
编码规范和代码注释规范的标准化不仅可以提高代码的可读性和可维护性，而且可以使得多人协同开发更加得心应手。
本文将从编码规范和代码注释规范两个方面来探讨其在软件开发中的重要性及应用方法。
一、编码规范编码规范是指在软件开发中制定的一套规定，用于规范代码的书写方式。
有了编码规范，开发人员可以更加高效地、统一地编写代码，从而降低开发过程中的错误率，节省时间和精力。
编码规范需要对一些书写细节进行标准化规范，下面我们来看一些常见的规范。
1.命名规范命名规范是指在命名变量、函数和类时的规则。
通常来说，命名应该反映变量、函数或类的作用和含义，应该采用有意义的词语，同时应该符合语言的命名规范，例如：1）变量名应该是一个名词，采用小写字母和下划线组成，如student_name。
2）函数名应该是一个动词，采用小写字母和下划线组成，如get_student_name。
3）类名应该是一个名词，采用大写字母开头的驼峰命名法，如StudentInfo。
2.注释规范注释规范是指在代码中添加注释，以便于代码的阅读和维护。
在注释时应该注意以下几点：1）注释应该使用简洁、明了的语言。
2）注释应该放在代码的上面或者右侧，而不是内嵌在代码中。
3）注释应该尽可能地详细描述代码的作用和逻辑，尤其是一些复杂的代码片段。
3.缩进规范缩进规范是指在编写代码时，应该按照一定的规则对代码进行缩进，以便于代码的可读性和可维护性。
通常来说，缩进应该按照以下原则进行：1）应该采用4个空格的缩进。
2）每个代码块应该有单独的缩进级别。
3）缩进应该注意对齐和排列方式。
二、代码注释规范在编写代码的同时，代码注释也是很重要的一环。
代码注释可以帮助其他人更好地理解代码和维护代码，在注释的时候应该遵循以下规范：1.注释类型通常来说，代码注释可以分为两种类型：行注释和块注释。
软件开发中的代码规范在软件开发过程中，代码规范是一个非常重要的方面。
它可以增强代码的可读性和可维护性，提高团队合作和代码质量。
代码规范涵盖了代码布局、命名规则、注释风格、函数编写等多个方面。
本文将探讨软件开发中的代码规范，并列举一些常用的规范实践。
一、代码布局良好的代码布局可以使代码更易于阅读和理解。
以下是一些常用的代码布局规范：1. 缩进：使用4个空格进行缩进，而不是制表符。
这样可以保持不同编辑器之间的一致性。
2. 换行：每行代码的长度应适中，一般不超过80个字符。
如果一行代码过长，可以使用换行符将其拆分为多行。
同时，运算符应该位于换行符之前。
3. 空行：在不同的代码块之间、函数之间和逻辑段落之间添加适当的空行，以提高可读性。
4. 对齐：在声明变量、定义函数等情况下，保持对齐的代码布局可以使代码更加整洁和易读。
二、命名规范命名规范可以使代码的含义更加清晰，并且便于其他开发人员理解和维护。
以下是一些常用的命名规范实践：1. 变量和函数名：使用有意义的命名，避免使用缩写和单个字符命名。
命名应使用小驼峰命名法，即首字母小写，后续每个单词的首字母大写。
2. 常量名：常量应使用全大写字母，并使用下划线分隔单词。
3. 类名：类名应使用大驼峰命名法，即首字母大写，后续每个单词的首字母大写。
4. 文件名：文件名应使用有意义的命名，避免使用特殊字符和空格。
文件名应与文件中定义的类或功能相匹配。
三、注释风格良好的注释风格可以增加代码的可读性和可维护性，方便其他开发人员了解代码的用途和实现逻辑。
以下是一些常用的注释规范实践：1. 文件注释：每个代码文件的开头应包含文件注释，描述文件的用途、作者和日期信息。
2. 函数注释：每个函数的开头应包含函数注释，描述函数的功能、输入参数、返回值和异常情况。
3. 行内注释：在复杂的代码段或关键逻辑处添加适当的行内注释，解释代码的用途和实现方式。
4. 注释更新：当代码发生变动时，应及时更新相关的注释，保持注释与代码的一致性。
JAVA编码规范v1.0目录1.关于 (3)2.项目结构 (3)2.1命名空间 (3)2.2源文件 (3)2.3文件目录存放 (3)3.命名约定 (4)4.排版 (5)5.Java文件格式 (6)6.注释规范 (6)7.代码编译 (8)8.性能 (8)9.测试及维护 (9)10.异常 (9)11.编程技巧 (10)1）使用 StringBuffer 对象 (10)2）避免太多的使用 synchronized 关键字 (10)3）避免使用 java.util.Vector 类 (10)4）面向接口编程 (10)5）避免使用索引来调用数据库中间层组件返回的结果集 (11)6）对于自己创建的每一个类，都考虑置入一个main() (11)7）应将方法设计成简要的、功能性单元 (11)8）设计一个类时，请设身处地为客户程序员考虑一下 (11)9）使类尽可能短小精悍，而且只解决一个特定的问题。
(12)10）采用内部类 (12)11）采用注释 (12)12）避免使用"魔术数字" (12)13）接口和抽象类的使用 (12)14）日志调试 (13)12.JSP编码规范 (13)13.日志框架 (14)14.事务处理 (16)1.关于本文档以JAVA编程语言为基础，提供编码规范的指导，以统一开发人员的书写标准，提高代码的可读性。
代码体系、接口规约、命名规则等，这是项目小组今后共同作战的基础，有了编码规范和程序模块之间和项目成员彼此之间的接口规则、方式方法，大家就有了共同的工作语言、共同的工作平台，使整个软件开发工作可以协调有序地进行。
2.项目结构2.1命名空间每个命名空间对应一个目录。
采用完整的英文描述符，应该都是由小写字母组成。
对于全局,将你的Internet 域名反转并接上包名如java.awt,com.ambysoft.www.persistence。
全局命名空间下的其它则按照功能进行划分,每个功能包下则按照放置的不同文件性质进行设置。
开发规范与要求范文开发规范是一系列的编码原则、技术规范、文档规范等的集合，旨在确保团队开发的代码质量、可读性、可维护性、可扩展性，并提高团队合作效率。
本文将介绍开发规范的要求以及其对项目开发的重要性。
一、命名规范1.变量、函数、方法的命名应具有清晰的表达意义，使用有意义的英文单词或单词的组合。
2.类名、接口名应使用名词或名词词组，并使用大写开头的驼峰命名法。
3.常量名应使用大写字母加下划线的形式，如：MAX_COUNT。
4.避免使用容易混淆的命名，如：i1,l1,O0等。
二、缩进与排版规范1. 使用合适的缩进风格，如四个空格或一个Tab，统一团队内部的缩进风格。
2.代码块的开始和结束要与其对应的可见的包含结构对齐。
3.行宽应控制在80-120个字符之间。
三、代码注释规范1.对于代码中的每个模块或功能，必须提供必要的注释说明。
2.注释应简明扼要、准确清晰，解释代码的关键逻辑以及设计思想。
3.注释应使用英文书写，并遵循一定的规范，如在注释前使用特定的修饰符以区分说明的对象。
四、代码规范1.遵循单一职责原则，每个函数、方法只负责一个功能，尽量避免一个函数或方法实现多种功能。
2.遵循开闭原则，尽量使用扩展而非修改已有的代码。
3.避免使用变量的魔法数值，应提取为常量或配置项。
4.代码尽量简单清晰，可读性强，避免冗余的代码和复杂的逻辑结构。
五、测试规范1.编写单元测试代码，保证代码的正确性和稳定性。
2.合理组织测试用例，覆盖代码的各种情况，包括正常情况和异常情况。
3.定期运行测试用例，及时发现和解决问题，确保程序的健壮性。
六、文档规范1.编写开发文档和用户文档，清晰描述程序的设计思路、开发流程、代码的使用方法等。
2.文档内容应准确、详尽，方便其他开发人员和用户了解项目的细节。
开发规范对于项目开发具有重要的作用：1. 提高代码质量和可维护性：规范的代码易于阅读和理解，减少错误和bug的产生，提高代码的可维护性和可读性。
软件开发规范：编码规范C#编码规范目标：1. 安全：代码完成所需的功能之余,不要产生负作用，即要稳定可靠。
2. 易读: 类、实例、成员变量、成员函数的命名一目了然3. 美观: 尽量统一项目组内人员的编程风格。
第一部分：命名1. 命名原则1) 所有的函数（变量/类/文件名）应该代表其实际的作用，应该使用有意义的单词或多个词组合，但不要使用人名、项目组名。
2) 所有的函数（变量/类名）一律使用英文。
3) 使用多个单词时不需要使用连线(如下划线), 但对于全部大写的宏需要使用连线。
4) 多个词组合较长时, 可以使用单词的缩写。
5) 不得使用非常相近的名字类表示几个不同含义的函数（变量/类）。
6) 命名时请考虑名字的唯一性和含义的准确性。
7) 使用项目组专用词汇来表达特定的含义(概念), 不得把专用词汇挪作他用。
2. 变量的命名原则: 使用匈牙利命名法命名变量1) 变量名一般由“类型修饰＋代表变量含意的英文单词或单词缩写”等部分组成。
类型修饰(小写字母)：n: int，l: LONG/long， s: short，u: UINT，f: floatb: bool，by: BYTE，ch: char， sz: char[],str: string2) 针对异常捕获过程中的 Exception 变量命名，在没有冲突的情况下，统一命名为e；如果有冲突的情况下，可以重复 e，比如：ee。
3. 函数的命名1) 使用动宾词组表达函数实际所作的事。
2) 同名的函数(重载函数)在功能上应该完全相同, 在参数上的差别也应一目了然。
3) 不得出现名字非常相近但功能不同的函数. 如 CreatePage1(), CreatePage2()等。
4. 类命名1) 名字应该能够标识事物的特性。
2) 名字尽量不使用缩写，除非它是众所周知的。
3) 名字可以有两个或三个单词组成，但通常不应多于三个。
4) 在名字中，所有单词第一个字母大写，缩写都要大写。
1Web开发规范概述Web开发规范是针对Web系统差别于传统的软件开发，为规范前台Web页面风格以及后台Java程序编码而编写的，为了保证开发代码风格的一致性、规范性和可读性，减少后期程序维护的工作量，要求项目组各成员在进行设计的过程中必需遵守执行，如果对本规范有异议或者需要在规范中增加新的条目，请尽早提出，以利于规范的更改以及相关代码的及时更改。
定义本规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。
本规范并不是一定要绝对遵守，但是一定要让程序文档有良好的可读性及统一的规则，具体项目可以根据项目的实际情况对本规范进行剪裁和补充，生成项目组成员实际遵守的开发规范，以达到适应不同开发工具不同开发模式的项目。
2Web页面开发规范2.1页面风格规范2.1.1页面统一规范页面风格必须保持一致，包括页面的前景色，背景色等内容，页面内容摆放遵循统一规则，对于页面风格尽可能使用CSS模式文件。
例如对于所有页面都要有“关闭”“返回”“帮助”链接：统一在页面左上角，顺序为“关闭”、“返回”、“帮助”。
处理规则：点击“关闭”链接，如果本页面是弹出的，则关闭本页面，否则返回到“任务列表”页面；点击“返回”链接，返回到上一个页面；点击“帮助”链接，弹出本页面的操作说明及下一步如何操作。
2.1.2操作按钮规范规范所有的按钮的展示属性，包括大小、尺寸及图标、tooltips等。
2.1.3录入项目规定所有界面的必选项目必须添加红色的“*”进行标注，并且在保存的过程中执行相应的判断并以提示信息的形式进行提示。
2.1.4信息框规定，提示信息，如必须项目确认信息，提示用户并需要得到用户的认可警告信息，系统处理失败需要提示用户的信息由客户引起的失败由应用程序引起的失败：删除必须以确认信息的形式进行说明成功保存处理后都必须以提示信息的方式进行提示失败处理必须以警告信息的形式进行提示2.2HTML编码规范●必须为title赋值并且在可能的情况下和页面内容中的标题一致；如果要为HTML文件加图片，图片的尺寸不能超过250*250，图片的大小不能超过30K,必须保证一个网页总长度限制在50k；必须定义每页的background color，即使background color为白色，也必须把它定义在<body>标签里；●用级联格式页（即CSS）定义显示方面的内容，例如：字体、边框等等；用Dreamweaver或其他专业工具作为HTML的开发工具；设计以800*600作为显示器的标准；●用IE4.0和Netscape4.0作为标准测试浏览器；尽量不用Frame；尽量避免使用动态HTML，例如：层……●使用封闭式标签(balanced tags)类似于<html></html>,<head></head>以及<body></body>这类标签，一页中只能用一次，以避免在Netscape浏览器里出现刷新问题，在被包含文件中，不允许用以上标签；源代码要格式良好（这一点尤其重要），要像其他程序源码一样有缩进；不允许使用中文全角空格，必须使用“ ”。
开发规范文档开发规范文档一、概述开发规范文档旨在规范开发团队的编码和开发标准，提高代码质量，降低维护成本，保证项目的稳定性和可扩展性。
本文档适用于所有的开发人员和项目。
二、命名规范1. 类名、接口名、枚举名使用大驼峰命名法，首字母大写，后续每个单词首字母大写，例如：UserService、CalculatorService；2. 变量名、方法名使用小驼峰命名法，首字母小写，后续每个单词首字母大写，例如：userName、calculateSum；3. 常量名全部大写，多个单词之间用下划线分隔，例如：MAX_LENGTH；4. 包名使用小写字母，并且能够反映该包的功能，例如：com.example.service；5. 数据库表名使用小写字母，并且采用下划线分隔，例如：user_info；6. 文件名使用小写字母，并且能够描述该文件的内容，例如：user_service.java。
三、代码规范1. 缩进和对齐：使用4个空格进行缩进，不使用Tab键；在定义变量和方法时，尽量对齐；2. 行长限制：每行不超过100个字符；3. 注释规范：每个类、方法、成员变量必须添加注释说明，方便他人理解；4. 异常处理：在捕获异常时，要进行适当的处理，避免出现空指针异常等运行时错误；5. 空行规范：在函数、类之间使用空行分隔，提高代码的可读性；6. 文件编码：使用UTF-8编码，禁止使用乱码字符；7. 导入包规范：按照层级结构进行导入，不使用通配符*；8. 常量和变量声明：常量建议使用final修饰，变量声明后要及时初始化；9. 错误处理：在遇到错误时，要及时打印日志记录，方便定位和解决问题；10. 重写方法：重写Object类的方法时，要加上@Override注解，增强代码的可读性。
四、注释规范1. 类注释：在每个类的前面添加注释，描述该类的作用和功能；2. 方法注释：在每个方法的前面添加注释，描述方法的输入参数、返回值和功能；3. 成员变量注释：在每个成员变量的前面添加注释，描述变量的作用和用途；4. 异常注释：在方法上方的注释中，说明该方法可能抛出的异常类型和原因。
软件开发中的编码规范和代码注释规范在软件开发中，编码规范和代码注释规范对于代码的可读性和可维护性起着至关重要的作用。
编码规范是一组约定俗成的规则，旨在规范代码的书写和格式化，使代码更加清晰易读，而代码注释规范则是指在代码中添加注释的规则和标准。
本文将分别从编码规范和代码注释规范两个方面展开讨论，以期为软件开发人员提供一些有益的指导和建议。
编码规范编码规范是指编程时应遵守的一系列规则和约定。
它不仅仅包括代码的格式化和排版，还包括一些最佳实践和设计思想。
良好的编码规范可以提高代码的可读性、减少错误、提高维护性，并且有助于多人协作开发。
下面我们将从代码格式化、命名规范和最佳实践三个方面介绍编码规范的内容。
1.代码格式化代码的格式化是指代码的排版和结构。
良好的格式化可以使代码更加清晰易读，便于他人阅读和理解。
以下是一些常见的代码格式化规范：-缩进：使用统一的缩进风格，比如使用4个空格或者一个制表符来进行缩进。
-行长：避免单行代码过长，建议控制在80-120个字符以内。
-空格和换行：在运算符两侧和逗号后应加空格，适当换行以提高代码的可读性。
2.命名规范良好的命名规范可以使代码的含义更加清晰明了。
下面是一些常见的命名规范约定：-变量名：使用有意义的变量名，遵循驼峰命名法或者下划线命名法。
-函数名：使用动词或动宾结构，清晰地表达函数的作用。
-常量名：使用大写字母和下划线来表示常量。
3.最佳实践除了代码格式化和命名规范，编码规范还包括一些最佳实践和设计思想，比如：-模块化：尽量将代码分解成独立的模块，便于复用和维护。
-函数设计：函数应该短小精悍，只做一件事情，并且要有清晰的输入输出。
-错误处理：合理处理异常情况，避免出现不可预期的错误。
-注释：代码中应该包含必要的注释，便于他人理解和维护。
代码注释规范代码注释是为了在代码中解释其含义和逻辑，以便他人理解和维护代码。
良好的代码注释可以使代码更具可读性和可维护性。
下面我们将从注释的内容、格式和位置三个方面介绍代码注释规范的内容。
软件开发规范《试行版》Version 1.0《编程语言开发规范》2004-6-31 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
要求：使用编辑器提供的tab设置功能，设置为4；绝对不允许使用4个空格字符¹1-2：不允许把多个短语句写在一行中，即一行只写一条语句。
示例：如下例子不符合规范。
rect.length = 0; rect.width = 0;应如下书写rect.length = 0;rect.width = 0;¹1-3：较长的语句（页宽>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied= stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
示例：如下例子不符合规范。
if (pUserCR == null) return;应如下书写：if (pUserCR == null){return;}¹1-5：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。
¹1-6：程序块的分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例：如下例子不符合规范。
if (...){... // program code}void example_fun( void ){... // program code}应如下书写。
for (...){... // program code}if (...){... // program code}void example_fun( void ){... // program code}2 注释¹2-1：一般情况下，源程序有效注释量必须在20％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
¹2-2：文件头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、修改日志等.示例：建议所有文件使用该格式；java文件使用javadoc要求的格式/*************************************************Copyright (C), 1988-1999, YOEE Info Tech. Co., Ltd.File name: // 文件名Author:Version: Date: // 作者、版本及完成日期Description: // 用于详细说明此程序文件完成的主要功能，与其他模块// 或函数的接口，输出值、取值范围、含义及参数间的控// 制、顺序、独立或依赖等关系Others: // 其它内容的说明History: // 修改历史记录列表，每条修改记录应包括修改日期、修改// 者及修改内容简述# Date Author Modification12*************************************************/¹2-3：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
示例：建议所有文件使用该格式；java文件使用javadoc要求的格式/*************************************************Description: // 函数功能、性能等的描述Pre-Conditions：// 前置条件Param: // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。
Return: // 函数返回值的说明Others: // 其它说明*************************************************/¹2-4：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
不再有用的注释要删除。
要求：每8行内，必须要有一条注释¹2-5：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
2-6：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
¹2-7：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
示例：如下例子不符合规范。
例1：/* get replicate sub system index and net indicator */repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;例2：repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;/* get replicate sub system index and net indicator */应如下书写// get replicate sub system index and net indicatorrepssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;¹2-8：注释与所描述内容进行同样的缩排。
说明：可使程序排版整齐，并方便注释的阅读与理解。
示例：如下例子，排版不整齐，阅读稍感不方便。
void example_fun( void ){/* code one comments */CodeBlock One/* code two comments */CodeBlock Two}应改为如下布局。
void example_fun( void ){/* code one comments */CodeBlock One/* code two comments */CodeBlock Two}¹2-9：将注释与其上面的代码用空行隔开。
示例：如下例子，显得代码过于紧凑。
/* code one comments */program code one/* code two comments */program code two应如下书写/* code one comments */program code one/* code two comments */program code two¹2-10：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
示例：if(…) //注释{…}else //注释{…}2-11：避免在一行代码或表达式的中间插入注释。
说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。
2-12：在程序块的结束行右方加注释标记，以表明某程序块的结束。
说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
示例：参见如下例子。
if (...){// program codewhile (index < MAX_INDEX){// program code} /* end of while (index < MAX_INDEX) */// 指明该条while语句结束} /* end of if (...)*/ // 指明是哪条if语句结束3 命名¹3-1：JAVA命名规范-Package 的命名Package 的名字应该都是由一个小写单词组成。
-Class 的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成-接口的命名与类名命名方式一致，但在该类名的前面增减大写字母“I”，表示接口的意思。
-方法的命名方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
如：run(); runFast(); getBackground()-Class 变量的命名变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头。
变量名不应以下划线或美元符号开头(尽管这在语法上是允许的)。
变量名应简短且富于描述。
变量名的选用应该易于记忆，即，能够指出其用途。
尽量避免单个字符的变量名，除非是一次性的临时变量。
临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。
-Static Final 变量的命名Static Final 变量的名字应该都大写，并且指出完整含义。
-参数的命名参数的名字必须和变量的命名规范一致。
-数组的命名数组应该总是用下面的方式来命名：byte[] buffer; 而不是：byte buffer[];-方法的参数使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：SetCounter(int size){this.size = size;}¹3-2：页文件、文件夹命名及管理命名原则：用代表其含义的英文单词、以及数字表示，不易翻译的用关键字拼音，字母要统一用小写，不得含空格和特殊字符（下划线和破折号除外），最好不要超过8个字符。
