有些开辟人员利用tab来对齐正文,而别的一些人会用空格来对齐

作者: 健隆 分类: 菏泽网站制作资讯 发布时间: 2020-07-18 10:21

对齐正文行

对那些外行末写有正文的代码,应当对齐正文行来使得轻易浏览

有些开辟人员利用tab来对齐正文,而别的一些人会用空格来对齐。因为tab在分歧的编辑器和集成开辟情况中会有所分歧,所以最好的方式是利用空格来对齐正文行。

2. 利用同一的气势派头
有些人感觉正文应当让非程序员也能看懂。别的一些人感觉正文需求面对的读者只是程序员。无论如何,正如Successful Strategies for Commenting Code中所说的,最重要的是正文的气势派头需求同一,而且老是面向沟通的读者。就本身而论,我嫌疑非程序员是不是会去读代码,所以我感觉正文应当面向程序员来写。

3. 对分歧级其余代码停止正文

对分歧级其余代码块,要利用同一的方式来停止正文。例如:

对每个类,需求包括一段简明扼要的描写,作者和上一次点窜的时刻

对每个方式,需求包括这个方式的用处,功用,参数和前往效果

当你在一个团队外面的时刻,采取一套正文的标准是异常重要的。固然,利用一种人人都承认的正文商定和对象(例如C#的XML正文和Java的Javadoc)在一定程度上能鞭策这项义务。

4. 利用段落正文

首先把代码块分化成多个“段落”,每个段落都履行单一的义务;然后在每个“段落”最先之前添加正文,告知浏览代码的人接下来的这段代码是干什么用的

5. 不要欺侮浏览者的聪明

这不单把时刻虚耗在写没用的正文下面,同时也在涣散读者的注意力。

6. 直接了当

不要在正文外面写过多的空话。防止在正文外面虚伪ASCII艺术,写笑话,作诗和过于冗杂。简而言之就是连结正文的复杂和直接。

 

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!