敲代码历经三载，兴许尚未弄通透注释究竟该如何去创作，方能于三个月之后依旧能够看得懂，这绝非在瞎扯打趣，乃是绝大多数程序员每日都在遭遇的绊脚石。
文件头注释要包含关键信息
代码文件，若为自己所创建，于每个开头之处都应当标明版权信息以及创建之人。其标准格式是© 2004 - xxxx，紧接着要加上创建者之姓名以及创建之日期，如此一来，无论何人看到该文件，均能够在第一时间明确其归属以及产生之时间。我曾见识过数量众多的并无文件头的代码，于维护之际，压根无从知晓该向谁去询问。
在文件的末尾之处，需要得留出一个用于记录修改日志的区域，当中文名以及修改日期，在每次功能或者接口出现较大调整之际，均是必须添加Log ID的，这样的一种习惯能够使得在该项目上线半年时间之后，依旧可以精确地追溯到每一项改动的因由以及相应的责任人，从而防止出现无端背黑锅的情况，这一点是非常重要的。
类属性注释规范写法
对于类的每一个属性而言，均需依据特定格式予以注释，此特定格式所涵盖的内容包含作用与读写权限。举例来说，运用///
属性注释可不能敷衍塞责。好多人写“用户名”“密码”这类废话我都见过，正确的做法是阐述清业务含义，就像这样子“用户登录名，必须具有手机号格式”。如此一来后续维护者才不会出现误用情况。
方法注释必须包含关键要素
写在方法声明之前的注释，得清晰地写明功能的描述，对参数进行说明，还要包含作者的信息，参数得用param name="xxx"来标明每个参数所蕴含的含义，对于返回值，要阐述清楚成功与失败分别代表着什么，作者以及日期都必须写成中文名字，此举是为了方便团队内部的沟通。
不少程序员嫌麻烦而不书写方法注释，结果便是自己所写的代码在两周之后就无法看懂。尤其是那些复杂的算法方法，要是没有注释就宛如天书一般。花费两分钟将其写明白，能够省下未来两小时用于排查问题的时间。
代码间注释要抓住重点
以//来进行单行注释,使用/ /去做多行注释,这可是基本规则。重点在于当碰到if、for、while等语句块之际一定要添加注释,以此来说明这段代码的作用以及实现手段。就像“遍历订单列表,计算出每个订单的运费优惠”这样。
并非注释数量越多便越好，而是需精准无误，像“i加1”这类垃圾注释等同于纯属废话，好的注释应当阐释“为什么要如此去做”，而非仅仅说明“做了些什么”，算法实现务必注明思路来源，例如“采用快速排序以优化性能”，如此这般。
变量命名规则必须严格执行
变量名通过将前缀与含义进行组合而构成，对于类模块级别的变量，采用m_加上数据类型缩写的方式，而在过程级中，则直接使用类型缩写，作为参数时，运用p_加上类型缩写的形式，如此一来，能够一眼便明晰变量的作用域以及类型，好比看到m_strUserName，即刻就能知晓它是类级别的字符串变量。
命名的时候，要采用大小写混合的方式，也就是每个单词的首字母都得大写。对于短生命周期变量而言，能够用i或者j来当作循环索引，而在其他的情形之下，就必须得使用有意义的名称才行。常量，要大写并且加上下划线，就像MAX_COUNT这 样。我，见到过那种用a、b、c去命名所有变量的项目，在调试的时候，简直都想撞墙。
编码规则决定代码质量
关键词下方同列处要放置大括号，缩进统一采用Tab，if语句嵌套最多为4层。函数返回值应避免使用复杂类型，成功时返回0，错误情况用负数表示。这些规范看似繁琐，不过能使代码结构清晰，不会出现那种几百行的大括号嵌套地狱的情况。
对于错误检查而言，其应当覆盖掉所有的执行路径，绝不能够仅仅去考虑正常的情况。嵌入式赋值这种情况是需要避免的，常量必须被定义成名字而并非是直接去写数字。当存在重复实现两次以上的功能时，那就需要将其模块化成通用函数。只有遵循以上这些规则，代码才能够称得上专业。
你现在的项目里，有多少代码是连你自己都不想看的？
Comments NOTHING