代码注释当我们第一次接触某段但又被要求在极短时间内有效地分析这.pdfVIP

代码注释规范 2010-10-20 1. 问题 ◆ 当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代 码，我们需要什么样的注释信息？ ◆ 怎么样避免我们的注释冗长而且凌乱 呢？ ◆ 在多人协同开发、 的今天，我们需要怎么样的注释来保证高质、高交的进 行开发和 工作呢？ 2. 意义 程序中的注释是程序设计者与程序阅读者之间通信的重要 。几乎没有任 何一个软件，在其整个生命周期中，均由最初的开发人员来 。好的注释可以 改善软件的可读性，可以让开发人员快速理解他所阅读的代码。 必须着重 的是：在代码层文档中起主要作用的并非注释，而是良好的编 成风格。编程风格包括良好的程序结构、直率易懂的方法、有意义的变量名 程序名、具名常量、清晰的布局，以及最低复杂度的控制流及数据结构。优秀的 编程风格带来的是优秀的自说 码。这种代码本身就是最好的注释。 但是，还有一些脱离编程语言层次的东西需要在代码文件中加以说明以有