全潮-在线咨询 咨询热线:0755-23607481,17722631175

咨询热线:0755-23607481,17722631175

新闻资讯

当前位置: 首页 - App开发资讯 - APP最新热评 - 深圳app开发:6个注释技巧


深圳APP开发

深圳app开发:6个注释技巧

发布时间: 2017-11-22 18:10:50   作者:小潮   浏览次数:10

关于不一样等级的代码块,要运用统一的办法来进行注释

深圳app开发:

 1. 对不一样等级的代码进行注释

关于不一样等级的代码块,要运用统一的办法来进行注释。例如:

关于每一个类,需求包括一段短小精悍的描述,作者和上一次批改的时间

关于每一个办法,需求包括这个办法的用途,功用,参数以及回来成果当你在一个团队里边的时分,选用一套注释的规范是非常重要的。当然,运用一种我们都认可的注释约好和东西(例如C#的XML注释和Java的Javadoc)在必定程度上能推进这项使命。

 

2. 运用阶段注释

首先把代码块分解成多个“阶段”,每一个阶段都履行单一的使命;然后在每一个“阶段”开端之前增加注释,通知阅览代码的人接下来的这段代码是干什么用的

 

3. 对齐注释行

关于那些在行末写有注释的代码,应当对齐注释行来使得便利阅览

有些开发人员运用tab来对齐注释,而别的一些人会用空格来对齐。因为tab在不一样的编辑器和集成开发环境中会有所不一样,所以最好的办法是运用空格来对齐注释行。

 

4. 不要凌辱阅览者的才智

要防止没用的注释,例如这不单把时间糟蹋在写没用的注释上面,一起也在涣散读者的注意力。

 

5. 要有礼貌

应当防止没有礼貌的注释,例如“要注意一些愚笨的用户会输入一个负数”,或许“批改由菜鸟工程师写的愚笨得不幸的代码而致使的副作用”。这样的注释关于代码的写注释的人来说并没有任何好处,一起你永远都不会知道将来这些注释会被谁来阅览,你的老板,一个客户或许是方才被你数说的愚笨得不幸的工程师。

 

6. 开门见山

不要在注释里边写过多的废话。防止在注释里边做作ASCII艺术,写笑话,作诗和过于冗长。简而言之即是保持注释的简略和直接。