程序员与项目经理矛盾之注释

      注释对于每个开发人员来讲并不陌生。说起它的好处，显而易见是为了能说明代码的涵意。现在的项目经理基于工程管理的需要，都希望每个开发人员，对其注释越详细越好。而对于开发人员来讲，基于自身考虑，比如：核心代码，保证自身的不可替代性，往往不想注释，或者根本就不注释。这样，二者之间就产生了一定矛盾的。在解决这矛盾的时候，往往项目经理，以其职权的威性来要求，就造成了开发人员反感。开发人员往往就敷衍了事，总是在心里想凭什么，来的时候啥都没有，来了就让注释，这不是故意让人穿小鞋吗？这样的情况有之，而且比较普遍。我认为这一是心态，二是现在竞争压力大，都是被逼的。

      如何能解决好这一矛盾，还请JE上的兄弟姐妹们共同出招。

评论

3 楼 yujiecheung 2009-08-17  

我个人始终坚持代码即注释的原则。注释仅在有必要说明为什么要这样做的时候才加。
注释是需要维护的，不仅仅是code。而维护就需要计算成本。如果注释维护不好，引起注释和code出现差异，后果是很严重的。我和我的同事，在工作中就经常遇到这种问题。
楼主可以让项目经理把维护注释的成本也计算进项目成本中。然后在来讨论关于注释的问题。

2 楼 seekgirl 2009-08-16  

好的程序力争做到0注释

1 楼 fentaiy 2009-08-15  

个人认为...写好注释是一个程序员的职业操守问题.也是一个良好的编程习惯，毕竟不能太自私了吧！...