网站制作中关于代码注释的7个技巧

2017-05-11 网站建设 4197 次阅读

1. 对齐注释行

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

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

2. 使用统一的风格

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

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

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

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

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

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

4. 使用段落注释

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

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

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

6. 直截了当

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

上一篇：为什么合肥很多企业做的网站没有效果？下一篇：网站建设好后要不要网络公司再提供售后服务？

相关新闻推荐

集团多分站网站，怎么做才不会互相抢排名

不少集团企业做网站开发的时候，会搭建多个分站，覆盖不同城市或者不同业务板块，本意是想扩大线上曝光，拿到更多搜索流量。但实际运营一段时间就会发现，多个分站的关键词互相打架，同个搜索词，几个分站来回抢排名，内部互相消耗，哪个站点都很难稳定排上去，整体的收录和权重都上不去。做集团类网站建设，如果前期架构规划不到位，多分站不仅起不到增益效果，反而会白白浪费优化精力。集团多分站出现抢排名，根源大多是内容高度...

2026-08-27

定制化网站建设适合哪些类型的合肥实体企业

合肥本地实体企业做线上阵地，不少会纠结选择模板建站还是定制化网站建设。模板站成本低上线快，但功能固定、扩展性差，很难匹配实体企业的业务特点。定制化网站建设不是大企业专属，很多合肥实体企业业务复杂、有品牌展示、获客转化需求，就更适合做网站定制，而不是套用现成模板。生产制造类实体工厂，是定制网站制作的主流群体。合肥不少加工制造工厂，产品规格多、品类繁杂，需要展示车间实景、生产设备、项目案例、资质证书，...

2026-08-27

网站开启 HTTPS 之后，哪些细节会干扰抓取

把网站切换到，很多人以为只是装一张证书就万事大吉，实际上线之后，会碰到抓取异常、收录停滞、新旧页面互相打架的情况，大多都是容易忽略的细节引发的。最常见的一类问题，就是页面内部还残留大量的资源调用。也就是常说的混合内容，、脚本、图片、插件资源还写死地址。浏览器有的会自动拦截部分资源，搜索引擎爬虫访问页面时，会出现页面渲染不全，样式缺失，部分模块加载失败。爬虫拿到的页面内容残缺，就没办法完整解析正文，...

2026-08-21

网站改版之后收录下跌，一般是哪些原因造成的

做网站运营时间久了，大多会碰到改版这件事。页面样式更新、栏目重新划分，本意是想让站点更贴合业务，可不少站点改完之后，直接出现收录掉量，索引页面数量往下滑。很多人第一反应会怀疑是算法调整，实际上多数情况，问题都出在改版过程里的操作细节，并不是搜索引擎刻意打压。最常见的一类问题，就是大量旧页面地址直接失效。改版重构程序的时候，直接把旧的全部作废，老页面返回404状态。搜索引擎之前已经抓取收录的大量页面...

2026-08-21

网站定制与模板站区别，企业长期运营该如何选择

搭建官网时，很多企业都会陷入两难：直接选用成熟模板站快速上线，或是投入预算开发网站定制方案。两种建站模式各有适用场景，单纯对比价格很难做出客观判断。如果只看重短期上线速度，忽视长期运营需求，后续很容易遇到功能受限、优化受阻、改版困难等问题，影响品牌展示与线上获客。模板站属于标准化成品网站，服务商提前开发好整套页面框架、栏目结构与基础功能，客户选定模板后，替换文字、图片、联系方式即可快速部署。最大优...

2026-08-17

低成本轻量化北京网站建设，模板二次重构和全新建站怎么抉择

不少合肥本地中小企业筹备搭建官网时，都希望控制前期投入，同时兼顾长期线上推广需求。低成本建站主要有两条路径：模板二次重构开发与从零全新建站。很多经营者容易单纯依据初期报价做决定，忽略后续优化、改版、适配、功能拓展等隐性成本，等到网站上线后想要调整架构、优化排名，才发现方案先天存在局限。理清两种方案的优劣势，结合自身运营规划选择，才能避免重复投入资金重建站点。模板二次重构，是以现成网站模板作为基础框...