2015061507 - 注释说明
来源:互联网 发布:星尘浏览器知乎 编辑:程序博客网 时间:2024/06/07 10:08
注释一般是对代码的说明和补充,如果代码能说明问题可以不添加注释,但是存在一个问题就是你认为表达的很清楚了,也许事实上真是表达很清楚.但是对于别人而言,未必能认为你的代码能表达很清楚.所以若干注释是必要的.
对于特定的业务,首批开发者对业务都比较熟悉,从技术开发角度而言可能对他来说很简单很容易,几句话的事情.
对于中途接手的继任者而言,从业务的不熟悉不了解到逐渐了解,难度不是从无到有的按照自己思路的开发,而是在现有代码基础上阅读并且继续开发.
如果没有详细设计说明书,而纯粹看现有代码来了解.有接触UFO的感触.对从中途接手开发到维护者而言,dao和service接口的注释说明都是十二分必要的,因为它们替代了详细设计说明书的作用!
类的注释,除了记录作者和开发时间,需要添加类的用途.而现有类上只是添加作者和时间.如果作者还在可以咨询若干,如果不在,那么注释等于垃圾注释.类的用途要比作者和时间更有使用价值.
方法,常见的用途可以不必写注释(现有代码注释比较少),说明方法用途,以及有特别注意事项,比如参数的注意事项,实现的特殊思路,以及为什么要这么去做.参数的含义基本都没有阐述.
如果都存在,方法调用者和后期代码维护者一定非常开心.
我深刻的感觉,对于后来的维护者而言,前任的最好给予就是足够的有用的注释!不写注释的开发者注定会被别人在他背后骂他的!
0 0
- 2015061507 - 注释说明
- Apache 配置注释说明
- hibernate注释说明
- Java文档注释说明
- 代码注释格式说明
- JSP的注释说明
- Hibernate注释说明
- C# 注释及说明
- Spring源注释说明
- rar注释行说明
- php注释说明
- C# 注释及说明
- eclipse代码注释说明
- php代码注释说明
- 注释说明代码
- nginx.conf 说明 注释
- JAVA注释格式说明
- java 注释标签说明
- 我的Java开发学习之旅------>解惑Java进行三目运算时的自动类型转换
- 《Java项目开发全程实录》的实例08企业门户网站(Jsp+javabean)学习笔记
- !HDU 1243 反恐训练营--dp--(最长公共子序列)
- 二叉查找树(6) - 最近公共祖先LCA
- 修改Java文件不用重启Tomcat服务
- 2015061507 - 注释说明
- 微软云虚拟机外网访问
- Python - VS Complier
- C#数据绑定
- java笔记15 多线程2(线程通信、Lock)
- 2015061508 - 注释分析(1)
- 开始写第一个android软件(聊天软件)
- Mysql修改字符集
- 2015061509 - 注释分析(2)