| 关键词: nbsp important 注释 段落 代码 border 一个 radius 方法 0px |
1. 对不同级别的代码进行注释对于不同级别的代码块,要使用统一的方法来进行注释。例如:· 对于每一个类, 需要包含一段简明扼要的描述, 作者和上一次修改的时间;· 对于每一个方法, 需要包含这个方法的用途, 功能, 参数以及返回结果.当你在一个团队里面的时候,采用一套注释的标准是非常重要的。 当然,使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。2. 使用段落注释首先把代码块分解成多个“段落”,每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释,告诉阅读代码的人接下来的这段代码是干什么用的?123456789101112
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系
[邮箱地址] 删除
|