建站资讯

培养良好的习惯 有关编码注解的七个方法

作者:admin 发布时间:2020-11-18
培养良好的习惯 有关编码注解的七个方法

 1. 对不一样级別的编码开展注解

针对不一样级別的编码块,要应用统一的方式来开展注解。比如:

针对每个类,必须包括一段简要简练的叙述,创作者和上一次改动的時间

针对每个方式,必须包括这一方式的主要用途,作用,主要参数及其回到結果

如果你在一个精英团队里边的情况下,选用一套注解的规范是是非非常关键的。自然,应用一种大伙儿都认同的注解承诺和专用工具(比如C#的XML注解和Java的Javadoc)在一定水平可以促进此项每日任务。

2. 应用文章段落注解

最先把编码块溶解成好几个“文章段落”,每个文章段落都实行单一的每日任务;随后在每个“文章段落”刚开始以前加上注解,告知阅读文章编码的人接下去的这一段编码是做什么用的

 

3. 两端对齐注解行

针对这些内行末写有注解的编码,应当两端对齐注解行来促使便捷阅读文章

一些开发设计工作人员应用tab来两端对齐注解,而此外一些人要用空格符来两端对齐。因为tab不在同的编写器和集成化开发设计自然环境时会有一定的不一样,因此最好的方式是应用空格符来两端对齐注解行。

 

4. 不必污辱阅读文章者的聪慧

要防止不起作用的注解,比如

 

我觉得单把時间消耗在写不起作用的注解上边,同时也在分散化阅读者的留意力。

5. 要有文明礼貌

理应防止沒有文明礼貌的注解,比如“要留意一些愚昧的客户会键入一个负数”,或是“调整由小白工程项目师写的愚昧得可伶的编码而造成的不良反应”。那样的注解针对编码的写注解的人来讲并沒有一切益处,同时你始终也不会了解未来这种注解会被由谁来阅读文章,你的老总,一个顾客或是是刚刚被你数落的愚昧得可伶的工程项目师。

6. 直接了当

不必在注解里边写过量的空话。防止在注解里边显摆ASCII造型艺术,写段子,作诗和过度冗杂。简单点来说便是维持注解的简易和立即。

7. 应用统一的设计风格

一些人感觉注解应当让非程序猿也可以看懂。此外一些人感觉注解必须应对的阅读者仅仅程序猿。essful Strategies for Commenting Code中常说的,最大要的是注解的设计风格必须统一,而且一直朝向同样的阅读者。就自身而论,我猜疑非程序猿是不是想去读编码,因此我认为注解应当朝向程序猿来写。


企业

固话: (电话总机)

手机上: (向主管)
售后服务:
Q Q: 
admin


点一下频次: 升级 【复印此页】 【关掉】

收缩