写程序时,注释是必须的。可以想像一下,当你去维护别人代码时,如果没有注释,会是多么的崩溃。

很多时候,去维护别人的代码,可能还不如自己重新写一个来的更快。

于是,注释,就显得很有必要。

相信有不少个,自己写过的代码,过一段时间后再去看,一脸的懵逼啊。这是我写的代码吗!可能顺便还会骂作者是SB。。。

所以说,一个好的注释,就非常有必要了。

这里,我就只说说对于一个程序或方法的总体 注释,至于代码细节的注释,以后有空再说。

首先,我们需要知道,作为一个代码的维护人员,他最想知道的是关于这段代码的什么信息呢?

最最最重要的,应该是这段代码是干什么的,是吧。

如果一段代码的注释,连这段代码是做什么的,都没有写清楚,那就本末倒置了。

然后,就是这段程序的作者是谁,什么时候写的,有什么入参、出参,都是什么作用。

最后,是谁维护过这段代码,为什么维护。

有了这些信息,再去看一段代码时,可能就会轻松多了。

说了这么多,下面给出一个程序脚本注释的示例,供大家参考。

功能说明:根据输入的日期参数,返回该日期是星期几
作者:macsishu.com(微信号:201855204)
版本号:V1.0
完成日期:2018.12.10
入参说明:date_str:日期字符串。格式:YYYY-MM-DD,如2018-12-18
出参说明:dayofweek:日期所在的周几。取值范围0-6,其中0指星期天
维护记录:2018.12.18 macsishu.com 将实现方式由localtime改为strftime

本站所有内容均为原创,本站保留所有权利。在保留原始来源链接的情况下,允许非商业用途的转载。拒绝一切商业性转载。

picture loss