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

网站在改版的时候如何避免降权问题

网站改版.jpg

正常的网站页面发展过程中毫无疑问网站是需要做改版的，可是你了解网站改版的一些常见问题吗?还是回答一场说改就改的实际操作。在我们给客户做网站优化的工作中发现，许多网站常有过不当的改版实际操作，最后被百度搜索引擎降权处罚的。今日这篇文章，我们就来讲一下这种任性的“神”操作方法。

一：更改网站源代码

感觉一个网站好多功能没法实现啊，他们的网站做的真好看，出于这些目的更改程序的公司絕對不少。可是最终的結果通常95%的都被降权了。而另一个的5%则是尽管网站更改软件程序，可是却做好了足够的SEO措施的网站。小编建议您：假如非应用程序太过老化，比较严重跟不上节奏的状况下，尽可能不要做更換软件程序的操作。

二：更改URL网页链接

做专业网站建设及seo优化15年时间常常对某些公司说一点：最好的SEO行得通方案，是最可行的计划方案。为什么呢说呢?在SEO优化一途，一些物品就是说刚开始自身判定了的，例如URL网页链接这里吧。一些网站做了“4层”URL网页链接格式，但是大家都知道3层内的URL网页链接是最有利于优化的。这个时候他就安奈不了自己了，愿意为网站更改URL网页链接，那麼真得可行吗?最好的，因此并不是最好的，最好的往往是最可行的!随便更改网站URL网页链接100%对综合排名产生不良影响，轻则排行少幅度下降，重则直接K站。

因此小编提醒您：假如网站URL不严重危害百度搜索引擎抓取，则不需要做改动。

怎么区分严重程度：A,发布的信息内容是不是可以被迅速百度收录?48小时内收录，都谈不上太大的问題B,发布的信息内容百度收录比例有多少，假如用好文章而言收录占比超出60%则一切正常。C,运用百度工具爬取诊断，是不是可以完成抓取?这3点往往是更为关键的。

三：删除网站网络数据

有些网站产品系列不要了，随后改版后就将那些网页页面在网络服务器中删除，那样的方法是极其不可取的。假如用不到的网络数据，只需要不在网站显示就可以了，为什么要立即删除掉呢?即便删除必须衡量这些栏目组是不是依然有价值，假如SEO上确定没有作用后，删除数据资料的时候还要跟百度提交“死链接”申请才可以。

四：网站经常修改

网站改版有很多部分网站被降权就是：不断的在网络服务器上对网站进行改动，而导致的。网站修改后的网页页面，蜘蛛爬行后就会对其做好存档，假如反反复复改动，不就是需要反反复复存档吗?网站优化假如涉及改动注意事项较多，如1天以上的事儿，必须将改动的文件下载到当地，全都改动完毕后，统一性的上传到服务器上进行修改。

五：线上栏目组提升

有些网站做栏目组增多的时候，会建设出大量栏目组，以后慢慢地的再给这些栏目组增加相匹配的信息内容。首先那样的方法就是不善的。是因为：在搜索引擎爬取的时候，发觉站点很多信息内容为空，轻则网页页面不收录，重则直接导致现阶段网站总体综合排名下跌。同时，也要查询新提升的栏目组是不是存在SEO上的BUG，例如：某些必要条件筛选，将会造成较多的蜘蛛黑洞，这种超链接肯定要提早将其“毙”掉的。

六：不做程序流程交叉

有一些网站看了就是网站页面两个程序，这类状况下尽管也可以做站，可是我们要说的是：尽可能不建议应用第二个应用程序，两套应用程序相互间，不一定彻底适配不说，乃至增加的应用程序SEO上的难题也必须重新处理一遍，你真得确认新的应用程序SEO上充分契合百度搜索引擎标准吗?再者，在综合排名上面一整套应用程序建设的站点，容易得到权重。

七：不做降权改动

网站刚被降权就对网站做改动，可是降权的根本原因你了解吗?同样，在咨询诊断的顾客中，也常常有一些站长网站降权，马上来找我们做确诊。我们规定对方是：等一个礼拜，假如综合排名无法复原再来做SEO诊断也不晚。实际上有一些网站在这里一个星期内，综合排名就正常了。在这里之前，假如做了改动，综合排名还能修复吗?这只是一个问号了!