应用程序开发人员的乐趣是解决问题并费尽心思编写出一行行代码,但是只要一提到文档他们就会夺眶而逃。给你的源代码归档会简化代码维护任务(的负担),但是这会花掉宝贵的时间。所以,开发人员有的时候会拖到最后一刻才去解决归档的问题,这个时候他们可能甚至无法完成归档工作。
解决这个问题的最好方法是从一开始就把归档工作作为拟开发项目的一个关键部分。.NET框架通过C#让这成为了可能。
注释的类型
注释在你的源代码里有不同的作用。例如,解释性的注释会对第一眼看上去很难理解的代码进行解释。这种类型的注释适用于排序算法、正则表达式,或者比较难以理解的循环。
另一种注释类型完全是出于归档的目的。也就是说,它还提供了关于代码特性的信息。这包括作者姓名、创建时间、修改时间、代码编写的目的、版本号、变更的历史,以及其他各种信息。
此外,你可以在适当的时候在整个源代码里加上零星的单行注释。单行注释常常被用来向其他的开发人员说明具体的变化,或者给某个需要进一步处理的地方做上标记(例如,要做的项目)。
确保标准的统一
尽管有注释要比没有注释好,但是一组开发人员使用共同的标准会具有更高的产出。标准可以通过个注释样式指南来实现。这个指南用来定义如何使用注释(以及代码编写)的多种元素。(这种指南的具体细节不是本文讨论的范围。)
使用C#里的注释
C#的注释和C语言所使用的句法很类似。用下面的句法就可以建立一个块注释:
/* This
*is
* a
* comment.
*/
或者:
/* This is a comment */
你可以在单独一行里或者紧挨着代码用两个斜杠(//)插入一个单行注释:
// This is a comment
或者:
int a = 0; //This is a comment
C#借用了Java以及其他语言的方式,支持一些特殊注释,这些注释能够被用来生成独立于代码的文档。