地址： 上海市静安区共和新路4718弄10号楼2楼
热线：400-166-3538
电话：13122077371
邮箱：sales@shyuanzhen.cn
1. 对不同级别的代码进行注释
对于不同级别的代码块，要使用统一的方法来进行注释。例如：
对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间
对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果
当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。
2. 使用段落注释
首先把代码块分解成多个“段落”，每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释，告诉阅读代码的人接下来的这段代码是干什么用的
3. 对齐注释行
对于那些在行末写有注释的代码，应该对齐注释行来使得方便阅读
有些开发人员使用tab来对齐注释，而另外一些人会用空格来对齐。由于tab在不同的编辑器和集成开发环境中会有所不同，所以最佳的方法是使用空格来对齐注释行。
4. 不要侮辱阅读者的智慧
要避免没用的注释，例如
这不单把时间浪费在写没用的注释上面，同时也在分散读者的注意力。
5. 要有礼貌
应当避免没有礼貌的注释，例如“要注意一些愚蠢的用户会输入一个负数”，或者“修正由菜鸟工程师写的愚蠢得可怜的代码而导致的副作用”。这样的注释对于代码的写注释的人来说并没有任何好处，同时你永远都不会知道将来这些注释会被谁来阅读，你的老板，一个客户或者是刚才被你数落的愚蠢得可怜的工程师。
6. 直截了当
不要在注释里面写过多的废话。避免在注释里面卖弄ASCII艺术，写笑话，作诗和过于冗长。简而言之就是保持注释的简单和直接。
7. 使用统一的风格
有些人觉得注释应该让非程序员也能看懂。另外一些人觉得注释需要面对的读者只是程序员。无论如何，正如Successful Strategies for Commenting Code中所说的，最重要的是注释的风格需要统一，并且总是面向相同的读者。就自己而论，我怀疑非程序员是否会去读代码，所以我觉得注释应该面向程序员来写。
1、网站建设频道
• • • • | 公司名称：上海缘震网络科技有限公司 开户银行：中国工商银行上海市彭浦支行 银行账号：1001 2508 0930 0206 455 |
总部：上海市奉贤区金海公路6055号29号3楼 分部：上海市静安区共和新路4718弄10号楼2楼 商务官网：www.shyuanzhen.cn 彦蓁科技：www.shyanzhen.cn | 缘震网络成立于 2014 年，公司主要经营全案策划，高端品质网站建设、多媒体视频宣传片制作、微信公众号开发、微信小程序开发、商城定制、SEO优化、电商托管、空间托管、网站维护、应用软件开发、手机端APP开发、等为客户提供一条龙网络运营解决方案的的技术型企业。我们在人力资源、业务范围、设计、技术、服务、信誉度、规范管理及企业文化等诸多方面完善自己，公司目前已与千余家各类客户进行长期战略合作，提供专业的网站建设与运营服务。我们的口号：广结良缘、震古烁今！ |
免费热线：400-166-3538
咨询QQ ：
微信咨询 : chunhua19820
直接咨询 
