个人中心
文章发布
退出
作者热门文章
- ubuntu12.04环境下使用kvm ioctl接口实现最简单的虚拟机
- Ubuntu 通过无线网络安装Ubuntu Server启动系统后连接无线网络的方法
- 在Ubuntu上搭建网桥的方法
- ubuntu 虚拟机上网方式及相关配置详解
25
4
CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.
这篇CFSDN的博客文章提高代码可读性的十大注释技巧分享由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.
本文讲述了提高代码可读性的十大注释技巧。分享给大家供大家参考，具体如下:
很多程序员在写代码的时候往往都不注意代码的可读性，让别人在阅读代码时花费更多的时间。其实，只要程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样就方便别人查看代码，也方便自己以后查看了。下面分享十个加注释的技巧:
1. 逐层注释 。
为每个代码块添加注释，并在每一层使用统一的注释方法和风格。例如:
针对每个类：包括摘要信息、作者信息、以及最近修改日期等； 。
针对每个方法：包括用途、功能、参数和返回值等.
在团队工作中，采用标准化的注释尤为重要。当然，使用注释规范和工具(例如C#里的XML，Java里的Javadoc)可以更好的推动注释工作完成得更好.
2. 使用分段注释 。
如果有多个代码块，而每个代码块完成一个单一任务，则在每个代码块前添加一个注释来向读者说明这段代码的功能。例子如下:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
// Check that all data records
// are correct
foreach (Record record in records)
{
if
(rec.checkStatus()==Status.OK)
{
. . .
}
}
// Now we begin to perform
// transactions
Context ctx =
new
ApplicationContext();
ctx.BeginTransaction();
. . .
|
3. 在代码行后添加注释 。
如果多行代码的每行都要添加注释，则在每行代码后添加该行的注释，这将很容易理解。例如:
|
1
2
|
const
MAX_ITEMS = 10;
// maximum number of packets
const
MASK = 0x1F;
// mask bit TCP
|
在分隔代码和注释时，有的开发者使用tab键，而另一些则使用空格键。然而由于tab键在各编辑器和IDE工具之间的表现不一致，因此最好的方法还是使用空格键.
4. 不要侮辱读者的智慧 。
避免以下显而易见的注释：写这些无用的注释会浪费你的时间，并将转移读者对该代码细节的理解.
|
1
2
|
if
(a == 5)
// if a equals 5
counter = 0;
// set the counter to zero
|
5. 礼貌点 。
避免粗鲁的注释，如：“注意，愚蠢的使用者才会输入一个负数”或“刚修复的这个问题出于最初的无能开发者之手”。这样的注释能够反映到它的作者是多么的拙劣，你也永远不知道谁将会阅读这些注释，可能是：你的老板，客户，或者是你刚才侮辱过的无能开发者.
6. 关注要点 。
不要写过多的需要转意且不易理解的注释。避免ASCII艺术，搞笑，诗情画意，hyperverbosity的注释。简而言之，保持注释简单直接.
7. 使用一致的注释风格 。
一些人坚信注释应该写到能被非编程者理解的程度。而其他的人则认为注释只要能被开发人员理解就行了。无论如何，Successful Strategies for Commenting Code已经规定和阐述了注释的一致性和针对的读者。就个人而言，我怀疑大部分非编程人员将会去阅读代码，因此注释应该是针对其他的开发者而言.
8. 使用特有的标签 。
在一个团队工作中工作时，为了便于与其它程序员沟通，应该采用一致的标签集进行注释。例如，在很多团队中用TODO标签表示该代码段还需要额外的工作.
|
1
2
3
4
5
|
int
Estimate(
int
x,
int
y)
{
// TODO: implement the calculations
return
0;
}
|
注释标签切忌不要用于解释代码，它只是引起注意或传递信息。如果你使用这个技巧，记得追踪并确认这些信息所表示的是什么.
9. 在代码时添加注释 。
在写代码时就添加注释，这时在你脑海里的是清晰完整的思路。如果在代码最后再添加同样注释，它将多花费你一倍的时间。而“我没有时间写注释”，“我很忙”和“项目已经延期了”这都是不愿写注释而找的借口。一些开发者觉得应该write comments before code，用于理清头绪。例如:
|
1
2
3
4
5
6
7
|
public
void
ProcessOrder()
{
// Make sure the products are available
// Check that the customer is valid
// Send the order to the store
// Generate bill
}
|
10. 为自己注释代码 。
当注释代码时，要考虑到不仅将来维护你代码的开发人员要看，而且你自己也可能要看。用Phil Haack大师的话来说就是：“一旦一行代码显示屏幕上，你也就成了这段代码的维护者”。因此，对于我们写得好(差)的注释而言，我们将是第一个受益者(受害者).
最后此篇关于提高代码可读性的十大注释技巧分享的文章就讲到这里了,如果你想了解更多关于提高代码可读性的十大注释技巧分享的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。
25
4
0
直接上代码，可以写在公共文件common和继承的基础类中，方便调用 ?
1、php服务端环境搭建 1.php 服务端环境 安装套件 xampp(apach+mysql+php解释器) f:\mydoc文件(重要)\dl_学习\download重要资源\apache
如下所示： Eclipse快捷键 Ctrl+1 快速修复 Ctrl+D: 删除当前行 Ctrl+Alt+↓ 复制当前行到下一行(复制增加) Ctrl+Alt+↑ 复制当前行到上一行(复制增加)
第一步：conn.PHP文件，用于连接数据库并定义接口格式，代码如下： php" id="highlighter_808731">
本篇文章整理了几道Linux下C语言的经典面试题，相信对大家更好的理解Linux下的C语言会有很大的帮助，欢迎大家探讨指正。 1、如果在Linux下使用GCC编译器执行下列程序，输出结果是什么？
安装完最新的Boost库 官方说明中有一句话： Finally, $ ./b2 install will leave Boost binaries in the lib/ subdirecto
为了梳理前面学习的《spring整合mybatis（maven+mysql）一》与《spring整合mybatis（maven+mysql）二》中的内容，准备做一个完整的示例完成一个简单的图书管理功
网站内容质量仅仅是页面综合得分里面的一项.不管算法如何改变调整,搜索引擎都不会丢弃网站页面的综合得分。 一般情况下我们把页面的综合得分为8个点： 1、标题的设置 (标题的设置要有独特性)
最近事情很忙，一个新项目赶着出来，但是很多功能都要重新做，一直在编写代码、debug。今天因为一个新程序要使用fragment来做，虽然以前也使用过fragment，不过没有仔细研究，今天顺道写篇文
Android资源命名规范 最近几个月，大量涉及android资源的相关工作。对于复杂的应用而言，资源命名的规范很有必要。除了开发人员之外，UI设计人员（或者切图相关人员）也需要对资源使用的位置非常
以前一直使用Hibernate，基本上没用过Mybatis，工作中需要做映射关系，简单的了解下Mybatis的映射。 两者相差不多都支持一对一，一对多，多对多，本章简单介绍一对一的使用以及注意点。
如下所示： ? 1
如果想在自定义的View上面显示Button 等View组件需要完成如下任务 1.在自定义View的类中覆盖父类的构造(注意是2个参数的) 复制代码 代码如下: publ
实现功能：实现表格tr拖动，并保存因为拖动改变的等级. jsp代码 ?
代码：测试类 java" id="highlighter_819000"> ?
红黑树是一种二叉平衡查找树，每个结点上有一个存储位来表示结点的颜色，可以是red或black。 红黑树具有以下性质： (1) 每个结点是红色或是黑色 (2) 根结点是黑色的 (3) 如果一个
废话不多说，直接上代码 ? 1
码代码时，有时候需要根据比较大小分别赋值： ? 1
实际项目开发中，我们经常会用一些版本控制器来托管自己的代码，今天就来总结下Git的相关用法，废话不多说，直接开写。 目的：通过Git管理github托管项目代码 1、下载安装Git 1、下载
直接上代码: 复制代码 代码如下: //验证码类 class ValidateCode { private $charset = 'abcdefghkmnprstuvwxyzABC
我是一名优秀的程序员,十分优秀！