1 背景:
1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息?
2.怎么样避免我们的注释冗长而且凌乱不堪呢?
3.在多人协同开发.维护的今天,我们需要怎么样的注释来保证高质,高效的进行卡法和维护工作呢?
2.意义:
程序中的注释是程序设计者与程序阅读者之间通信的重要手段.应用注释规范对于
软件本身和软件开发人员而言尤为重要.并且在流行的敏捷开发思想中已经提出了将注释
转为代码的概念!
好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其
整个生命周期中,均由最初的开发人员来维护.
好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码.
好的注释规范可以最大限度的提高团队开发的合作效率.
长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力;
|
|