代码注释技巧
摘要：
提高代码可读性的10个注释技巧很多程序员在写代码的时候往往都不注意代码的可读性，让别人在阅读代码时花费更多的时间。其实，只要程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样就方便别人查看代码，也方便自己以后查看了。下面分享十个加注释的技巧：1. 逐层注释为每个代码块添加注释，并在每一层使用统一的注释方法和风格。例如：针对每个类：包括摘要信息、作者信息、以及最近修改日期等；针对每个方法：包括用途、功能、参数和返回值等。在团队工作中，采用标准化的注释尤为重要。当然，使用注释规范和工具(例如C#里的XML，Java里的Javadoc)可以更好的推动注释工作完成得更好。2. 使 阅读全文
posted @ 2012-07-17 09:58 漩涡鸣人 阅读(1541) 评论(0) 推荐(0) 编辑