代码注释和格式化的 10 个最佳实践
摘要:代码注释和格式化的目的都是为了让代码更容易阅读和理解,提升了代码的可维护性,下面是 10 个关于代码注释和格式的 10 个最佳实践(特别是 Java)。代码注释注释是代码的一部分,在统计代码行时注释也包含在内,非常重要。一段无任何注释的代码很可能是完全无用。尽管有些极端的建议说代码应该有自注释的方法,不过我们还是建议注释良好代码的必要条件。只在需要的时候编写注释不要为每行代码都编写注释,无用而且降低可读性,例如:int count = 0; // 给 count 变量设置初始值,这人人都能看懂 (?!?)缺少注释会增加代码维护难度和实践,首先变量和方法名应该是可理解和自注释的,下面是两个不好的
阅读全文
posted @ 2012-03-23 10:43