2015061509 - 注释分析(2)
2015-06-16 00:35
225 查看
对于下面类似的接口
接口参数过多就表明设计有问题.可以实现功能,但是没有考虑可扩展性,没有替维护人员考虑.考虑的只是眼前功能而已.如果不考虑上面问题,那么新项目和现在的代码可维护程度都差不多.严重破坏开闭原则.
个人还是建议类上说明类的用途,重要属性的含义,方法的作用,方法如何实现,方法的注意事项.当然不是全部,而是有侧重点地加以注释说明.
没用的注释在提交之前清理掉.
多余的注释清理掉
注释内容需要和代码数据同步修改,否则不如没有注释
如果没有UML类图,那么建议使用如下注释
因为这种注释代替了UML类图对字段的说明.
接口参数过多就表明设计有问题.可以实现功能,但是没有考虑可扩展性,没有替维护人员考虑.考虑的只是眼前功能而已.如果不考虑上面问题,那么新项目和现在的代码可维护程度都差不多.严重破坏开闭原则.
个人还是建议类上说明类的用途,重要属性的含义,方法的作用,方法如何实现,方法的注意事项.当然不是全部,而是有侧重点地加以注释说明.
没用的注释在提交之前清理掉.
多余的注释清理掉
注释内容需要和代码数据同步修改,否则不如没有注释
如果没有UML类图,那么建议使用如下注释
因为这种注释代替了UML类图对字段的说明.
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- Mysql修改字符集
- 微软云虚拟机外网访问
- 2015061508 - 注释分析(1)
- 二叉查找树(6) - 最近公共祖先LCA
- C#数据绑定
- java笔记15 多线程2（线程通信、Lock）
- 事件监听的三种方法
- 修改Java文件不用重启Tomcat服务
- 2015061507 - 注释说明
- [LeetCode][JavaScript]Text Justification
- ！HDU 1243 反恐训练营--dp--（最长公共子序列）
- Android基本架构
- 《Java项目开发全程实录》的实例08企业门户网站(Jsp+javabean)学习笔记
- 2015061506 - 代码分析之代码格式(3)
- 转-Fragment+ViewPager组件(高仿微信界面)
- regular-第一课（正则表达式基础）
- java使用dom4j解析xml字符串
- 二叉查找树(5) - 判断一棵二叉树是否为BST
- Adding an instance to a MEF container
- 题库类产品如何计算题目的难度值