良好代码注释

良好的代码注释:

程序名称;
程序的目的;
谁在什么时候写的代码;
版本号;
复杂代码片段的目的是什么;
总体设计思想是什么;
源代码是任何组织的;
输入数据的前提假设是什么;
还缺少哪一部分部分代码,程序还不能处理哪些情况;
使用有意义的名字;
使用一致的代码层次结构;
代码应该被分成许多小函数,每个函数应该很短;
在可能的情况下,使用标准库而不是自己写的代码;

猜你喜欢

转载自blog.csdn.net/qq_37774304/article/details/85039126