增加代码可读性——注释篇
来源:互联网 发布:烟台新天宇软件 编辑:程序博客网 时间:2024/05/19 02:17
程序员在写代码的时候,注意为代码加注释,并以合理的格式为代码加注释,这样可以方便别人查看代码
1. 逐层注释
针对每个类:包括摘要信息、作者信息、以及最近修改日期等;
针对每个方法:包括用途、功能、参数和返回值等。
2. 使用分段注释
如果有多个代码块,而每个代码块完成一个单一任务,则在每个代码块前添加一个注释来向读者说明这段代码的功能。
3. 在代码行后添加注释
如果多行代码的每行都要添加注释,则在每行代码后添加该行的注释。
4.为自己添加注释
即使是自己写的代码,三个月后看也会一脸茫然,为自己写注释,可以方便查找,以便维护。
5.边写代码边注释
可以方便自己理清思路
0 0
- 增加代码可读性——注释篇
- 提高代码可读性的注释技巧
- JavaScript 注释JavaScript 注释可用于提高代码的可读性。
- 整洁代码——提高代码可读性方法简述
- C# 学习笔记 -- 第二天 使用注释提高代码可读性
- 提高代码可读性的十大注释技巧
- 提高代码可读性的10个注释技巧
- 提高代码可读性的10个注释技巧
- 提高代码可读性的十大注释技巧
- 提高代码可读性的十大注释技巧
- JavaScript-注释可用于提高代码的可读性
- 在类中不添加注释。影响可读性。代码繁杂。
- 提高代码可读性的十大注释技巧
- 提高代码可读性的十大注释技巧
- 代码可读性
- TM_前端开发代码命名的规范化整理(增加代码可读性)
- 代码可读性例子
- 六个维度:代码可读性
- ubuntu系统安装后无法连接无线问题
- 自定义progressBar
- js学习中的问题 indexOf() toFixed()
- js基础学习
- 【重大更新】DevExpress v16.2新版亮点(Reporting篇)
- 增加代码可读性——注释篇
- DEDECMS所有标签调用方式大全
- dao层与service层傻傻分不清楚
- 仪表盘 网速测试 自定义view
- split()分割字符串
- replace() 替换
- PHP实现各种经典算法
- Mysql和Java数据类型对比一览表
- 入门Webpack,看这篇就够了