好的程序应该有好的程序架构和好的注释,没有注释的程序对于任何读程序的人来说就像是nightmare。
目前就我有限的水平,我觉得写注释的时候至少有这几点应该注意一下:
首先,每个文件的开头都应该有一段注释。这段注释应该表明程序的作者,版本之类的信息,这些都是一些很general的东西。同时,还应该交代这个文件中所实现的功能。
其次,每个单独的函数体,如果函数体实现的功能并不是很简单,以至于一眼就能看出来的话,有必要给函数体写注释。由于最近看的stanford的东西比较多,觉得这种函数体的注释比较好:
/*
* Function: GetScoresAndAverage
* Usage: avg = GetScoresAndAverage(10);
* -------------------------------------
* This function prompts the user for a set of values and returns
* the average.
*/
交代函数体的名字和函数的用法,隔一行再交代函数所实现的功能。
再次,在函数体中如果实现了比较复杂的算法,有必要对算法进行简短的概括,算法的输入和输出,算法的大概实现方法。
注释不要太多,但是没有注释却是完全不行的。