[讨论]论坛是否应该提倡给代码加注释

namejm

　　有会员反映说，如果给代码加上注释，将会给新手学习带来很大方便，也方便别人检查。请大家讨论一下，论坛是否应该提倡给代码添加注释？如果要添加，将用何种格式添加？请大家给出赞成或反对的理由，论坛将在大家合理建议的基础上，做出相应的调整。

==============传说中的分割线，强力分隔上下文=====================

　　发现大家的讨论对这个提倡有点误解，以为是对每个代码都强制要求写注释，实际上，对每个代码都添加注释是没必要的，也是不可能的，我们只是提倡对代码添加注释，以方便新手的学习而已，而非强制要求。如果论坛能坚持这样做，将会极大方便新手的学习，并且能形成论坛的特色——不必人人都如此，只需要有几个人能长期坚持下来就已经足够了。

namejm

Re dali 第5楼：

　　你这个建议也不错，论坛将会考虑推广这种做法，但是不一定非得由管理人员在QQ群里发，因为管理人员不一定全天都在线，会员也可以发。

To all：

　　如果有和本主题不同的其他提议，建议在相应版块另开新帖讨论，以便做到专帖专用，希望后面的帖子能专注于顶楼的讨论。

namejm

　　xxx引用的话说得好：代码不是只给机器执行的时候才用的，更重要的，是要给人看的，不仅仅是别人，还有可能是给自己看。

　　有可能是日后要持续维护代码，也可能是想从以前写的代码中抽出一些片段拿来复用……1天之后，你可能还记得自己当初每条代码的含义；一个月之后，你可能只能理解到90%；半年之后，你可能还记得住50%；1年之后，你很可能连自己当初的思路都已经彻底忘掉了。该怎么办？

　　答案是：养成随手写注释的习惯！

namejm

　　注释比代码多就没必要了，注释和代码一样应该提倡简洁、清晰。