2015061509 - 注释分析(2)

    对于下面类似的接口

   

    接口参数过多就表明设计有问题.可以实现功能,但是没有考虑可扩展性,没有替维护人员考虑.考虑的只是眼前功能而已.如果不考虑上面问题,那么新项目和现在的代码可维护程度都差不多.严重破坏开闭原则.

    个人还是建议类上说明类的用途,重要属性的含义,方法的作用,方法如何实现,方法的注意事项.当然不是全部,而是有侧重点地加以注释说明.

    没用的注释在提交之前清理掉.

   

    多余的注释清理掉

   

   

    注释内容需要和代码数据同步修改,否则不如没有注释

   

    如果没有UML类图,那么建议使用如下注释

   

    因为这种注释代替了UML类图对字段的说明.
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值