养成好习惯关于代码注释的7个技巧

首页> 缘震优势

缘震优势

最新动态缘震优势网建知识

2015-11-13 00:00:00

1. 对不同级别的代码进行注释

对于不同级别的代码块，要使用统一的方法来进行注释。例如：

对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间

对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果

当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。

2. 使用段落注释

首先把代码块分解成多个“段落”，每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释，告诉阅读代码的人接下来的这段代码是干什么用的

3. 对齐注释行

对于那些在行末写有注释的代码，应该对齐注释行来使得方便阅读

有些开发人员使用tab来对齐注释，而另外一些人会用空格来对齐。由于tab在不同的编辑器和集成开发环境中会有所不同，所以最佳的方法是使用空格来对齐注释行。

4. 不要侮辱阅读者的智慧

要避免没用的注释，例如

这不单把时间浪费在写没用的注释上面，同时也在分散读者的注意力。

5. 要有礼貌

应当避免没有礼貌的注释，例如“要注意一些愚蠢的用户会输入一个负数”，或者“修正由菜鸟工程师写的愚蠢得可怜的代码而导致的副作用”。这样的注释对于代码的写注释的人来说并没有任何好处，同时你永远都不会知道将来这些注释会被谁来阅读，你的老板，一个客户或者是刚才被你数落的愚蠢得可怜的工程师。

6. 直截了当

不要在注释里面写过多的废话。避免在注释里面卖弄ASCII艺术，写笑话，作诗和过于冗长。简而言之就是保持注释的简单和直接。

7. 使用统一的风格

有些人觉得注释应该让非程序员也能看懂。另外一些人觉得注释需要面对的读者只是程序员。无论如何，正如Successful Strategies for Commenting Code中所说的，最重要的是注释的风格需要统一，并且总是面向相同的读者。就自己而论，我怀疑非程序员是否会去读代码，所以我觉得注释应该面向程序员来写。

建好网站需要解决什么难题

建网站对企业来说非常容易，但建好网站却没那么容易。企业最希望的是与同行竞争时超越同行，网站大家都有建，但网站建得好对企业更有帮助。因为网站对客户有吸引力，容易使客户点击浏览，增加产品曝光率。知道的人越多对企业越有利，对销售产品更有帮助。有的企业建网站就像赶鸭子上架，选个模板第二天就上线。却没有考虑这个模板是否企业所需，对企业是否有帮助。实际上，要建好网站需要把一些问题解决了，接下来润壤建网站公司说说，建好网站需要解决什么难题！

建好网站需要解决什么难题

　　第一：确定网站类型与客户需求

　　企业在建网站之前最好能清楚确定网站类型与客户的需求，要明白网站面向的是更庞大的客户群而不是自己企业里的小团体。需要充分了解客户对网站的需求，目前的市场竞争以及企业本身的发展方向等做一个分析调查。接下来要做的就是对网站进行设计，根据分析结果把一些需求都搬到网站里。网站里要怎样的风格排版和功能效果，能给客户提供哪些实用信息，产品的展示设计等都是企业要考虑到的问题。客户群是什么年龄段的都有，把一些综合性的元素应用到网站里不失为一个好方法。

　　第二：突出产品特色

　　网站在设计风格的时候一定要把企业行业与产品特色表现出来，要的并不是一个平平淡淡的企业网站，而是一个主题明显的企业网站。一家企业有那么多类型的产品，不可能每一个都重点介绍，只有比较热销或新款的产品才会放在首页隆重介绍。因此在设计网站时先以产品为重点，并且在设计广告图与文字组织时要有视觉冲击。网站的框架布局要合理，文字与图片的展示需要放在适合的位置，切忌文字与图片的堆砌，展示太多的内容不利于客户浏览，只展示重要内容让客户能更容易获取。

　　第三：网页展示要统一

　　有的企业觉得每个栏目都不一样，需要有自己的特色，于是产品中心一个风格，企业简介一个风格，联系方式也一个方格，让客户浏览时能有足够的新鲜感。在建网站的时候重要的是有统一的网页展示，不管是首页还是内页。栏目有个性是可以让客户产生新鲜感，但容易与网站整体内容区分开来，浏览网页时没有产生联想，好像在不同的网站里。所以在建网站的时候要把元素应用在各个网页里，让不同的网页之间有联系是一个整体。可以设计统一的留白间距或者背景颜色来增加统一性。

　　网站里充分体现企业特色，产品特色并且内外风格统一，让客户印象深刻，这样的网站对企业更有帮助。企业建网站的时候首先就要把这几个难题解决好，想要比同行网站建得好比的就是特色。