养成好习惯关于代码注释的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中所说的，最重要的是注释的风格需要统一，并且总是面向相同的读者。就自己而论，我怀疑非程序员是否会去读代码，所以我觉得注释应该面向程序员来写。

企业如何使建的网站看起来有格调

一、要看能否表现出企业自身的特点，建一个有格调的网站能产生一种无形的交流，将企业自身的优势与特点表现出来使访客了解，这样一来对于网站转化程度来说就已经转化了50%。这样建的网站所起到的交流作用再加上对访客适当的引导，转化为企业的效益就是水到渠成的事情。那么如何才算是交流呢？在建网站把企业取得的成就与日常活动通过图片或文字的形式发布到网站上，当然，也可以是视频，给访客一种印象就是这是一个什么样的企业，虽然没有亲身经历，但是图文介绍之间的企业形象已经呈现到了访客的眼前。

　　二、在建网站时运行最新的网页技术，技术所带来的便利往往不只是其它方面，而建网站的技术也是飞速发展，日新月异的，一个有格调的网站在技术方面往往也不会落后于别人，目前运行到网站上比较流行的技术包括视差图片切换，扁平的树于结构，用视频来代替原来banner图作为背景，还有类似于单页面的滑动跳转等。技术也代表了一种实力，与普通的只有简单页面的网站相比，运用了大量技术的网站看上去也是一种实力的象征，用户会倾向于有实力的网站，而这种网站有实力的格调正是技术所带来的。

　　三、内容贵精不贵多，一个有格调的网站在内容方面从来都是留白居多，多余的内容采用动态加载或是翻页的形式来表现，适当的留白能够使人的视觉聚焦于内容的主要区域。通过有限的内容表现出远超几倍的信息，这也是一种有格调的表现。相反，如果把网站的页面堆的满满的，形容人多时我们通常会说某个地方挤的无法落脚，但形容建网站版块堆放可以说是没有地方落鼠标了，充斥者大量的版块，在这其中鼠标都不敢乱点，生怕会点到不想点的链接上去，内容虽然堆的多，但显得拥挤，在浏览时反而不容易区分内容与内容的区别，还会给人一种廉价的感觉。

　　四、突出企业品牌让建的网站看起来有格调，比如在一个简约的页面区域里，却只放置一个logo，然而让人看了反而不觉得这样会空旷，这就是视觉方面的运用，在企业建网站时我们可以在网站上通过各种方式来突出企业的品牌，比如从文字、色彩、图片或是视频方面来突出企业的品牌形象，一个网站如果能够树立起企业的形象，那么也就说明建的这个网站是一个有格调的网站。