13个代码注释的小技巧

13个代码注释的小技巧这篇文章是由José M. Aguilar在他卓越的博客中以西班牙语的形式首发，其后Timm Martin在获得Aguilar先生的授权下，对该文章进行翻译、修改，并且在DevTopics上发布。以下13个小技巧可以使得你的代码在长时间内依然能够保持容易理解和维护。 1. 对不同级别的代码进行注释对于不同级别的代码块，要使用统一的方法来进行注释。例如：对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具（例如C#的XML注释和Java的Javadoc）在一定程度上能推动这项任务。 2. 使用段落注释首先把代码块分解成多个“段落”，每一个段落都执行单一的任务；然后在每一个“段落”开始之前添加注释，告诉阅读代码的人接下来的这段代码是干什么用的复制内容到剪贴板代码: // 检查所有记录都是正确的 foreach (Record record in records) { if (rec.checkStatus()==Status.OK) { . . . } } // 现在开始进行处理 Context ctx = new ApplicationContext(); ctx.BeginTransaction(); . . . 3. 对齐注释行对于那些在行末写有注释的代码，应该对齐注释行来使得方便阅读 const MAX_ITEMS = [...]

可以推荐看那看这些文章：

struts2代码执行漏洞

wordpress用代码插入flash

dapeng 2012主题

《别让我思考》web设计之道

来自无觅网络的相关文章：

一键清理系统垃圾（附带代码） (@laycher)

记事本的两个小技巧 (@laycher)

RAMDisk,QSoft RamDisk安装和设置视频教程 (@laycher)

外文文献搜索技巧 (@laycher)

无觅

转载于:https://www.cnblogs.com/joypen/archive/2011/12/31/2322000.html

13个代码注释的小技巧相关推荐

13个代码注释的小贴士
下面的13条小贴士可以帮助你写出更规范.更容易维护的代码注释. 1.逐层注释使用统一格式对每一个语句块进行注释,如: 类:简单描述.作者.最后修改时间等方法:关于该方法的目的.函数.参数.返回值的 ...
十三个代码注释的小技巧
1. 对不同级别的代码进行注释对于不同级别的代码块,要使用统一的方法来进行注释.例如: 对于每一个类,需要包含一段简明扼要的描述,作者和上一次修改的时间对于每一个方法,需要包含这个方法的用途,功能 ...
盘点 10 个代码重构的小技巧
本次我们抛开 JAVA 虚拟机源码这些相对底层的东西,LZ 来与各位探讨一下几个代码重构的小技巧,这些内容部分来自于书籍当中,部分来自于 LZ 维护项目当中的一些实践经验.如果猿友们曾经用过这种手法, ...
R语言ggplot2调整图例和注释的小技巧（图例透明度，大小，注释位置自动调整）
Hallo,大家好,今天和大家分享一下ggplot2画图时的一些小技巧,主要是图例和注释的修改.(图例透明度,大小,注释位置自动调整) 先来一张普通的图. ggplot(mtcars,aes(mpg, ...
三周写出高性能的Python代码，这些小技巧你值得一试。
1一个不上进的 Python 使用者我是一个有 C 语言背景的开发者.最近转做了 Python,平时用 Python 还算 6,这周在给新员工分享工作之后,有个小孩跑来问我:"哥,你是学 ...
FANUC查找PMC [符号注释] 的小技巧
前言首先了解一下FANUC PMC梯形图内部的各字母符号含义: 本文转载自微信公众号数控笔记微信号:shukongbiji 提供免费技术支持如有需要请联系杨先生 1802 ...
30 段极简 Python 代码：这些小技巧你都 Get 了么？
选自 | towardsdatascienc 编译 | 机器之心学 Python 怎样才最快,当然是实战各种小项目,只有自己去想与写,才记得住规则.本文是 30 个极简任务,初学者可以尝试着自己实现 ...
30段极简Python代码：这些小技巧你都Get了么（附代码链接）
来源:机器之心本文约3200字,建议阅读8分钟. 本文带你了解30个极简任务,它们都是平常非常实用的技巧,我们只要花几分钟就能从头到尾浏览一遍. 学 Python 怎样才最快,当然是实战各种小项目, ...
30段极简Python代码：这些小技巧你都Get了么
学 Python 怎样才最快,当然是实战各种小项目,只有自己去想与写,才记得住规则.本文是 30 个极简任务,初学者可以尝试着自己实现:本文同样也是 30 段代码,Python 开发者也可以看看是不是 ...

13个代码注释的小技巧

13个代码注释的小技巧相关推荐

最新文章

热门文章