对于下面类似的接口
接口参数过多就表明设计有问题.可以实现功能,但是没有考虑可扩展性,没有替维护人员考虑.考虑的只是眼前功能而已.如果不考虑上面问题,那么新项目和现在的代码可维护程度都差不多.严重破坏开闭原则.
个人还是建议类上说明类的用途,重要属性的含义,方法的作用,方法如何实现,方法的注意事项.当然不是全部,而是有侧重点地加以注释说明.
没用的注释在提交之前清理掉.
多余的注释清理掉
注释内容需要和代码数据同步修改,否则不如没有注释
如果没有UML类图,那么建议使用如下注释