是否有可能在没有任何评论的情况下编写好的和可理解的代码？

Question

任何人都可以建议在没有一行注释的情况下编写可以理解的优秀代码的最佳方法是什么？

Answer 1

阅读Code Complete,第2版封面.也许两次.

给出一些细节:

• 使代码可读
• 消除代码重复
• 在编写代码之前进行设计/体系结构

Answer 2

我在大学时曾经有一位教授告诉我,任何好的代码都不应该需要任何评论.

她的方法是将非常精确的逻辑组合成具有非常描述性的方法/属性/变量名称的小函数.事实上,她提出的大部分内容都非常易读,没有任何评论.我试着对我写的一切做同样的事情......

Answer 3

我喜欢'人性化'代码,所以代替:

if (starColour.red > 200 && starColour.blue > 200 && starColour.green > 200){
   doSomething();
}

我会这样做的:

bool starIsBright;
starIsBright = (starColour.red > 200 && starColour.blue > 200 && starColour.green > 200);

if(starIsBright){
   doSomething();
}

Answer 4

在某些情况下 - 是的,但在许多情况下没有.其他人已经回答了" 是"部分 - 保持简单,写得很好,给它可读的名字等等.当你在代码中解决的问题根本不是代码问题而是域特定问题或业务时,没有任何部分可用逻辑问题.即使它没有评论,我也没有问题阅读糟糕的代码.这很烦人,但可行.但是,如果不理解为什么它会像这样以及它试图解决什么,那么几乎不可能阅读一些代码.所以像:

if (starColour.red > 200 && starColour.blue > 200 && starColour.green > 200){
   doSomething();
}

看起来不错,但在程序实际执行的环境中可能毫无意义.我宁愿这样:

// we do this according to the requirement #xxxx blah-blah..
if (starColour.red > 200 && starColour.blue > 200 && starColour.green > 200){
   doSomething();
}

Answer 5

编写良好的代码可能不需要评论来解释你正在做什么,但你仍然需要评论来解释原因.

Answer 6

使用描述性变量名称和描述性方法名称。使用空格。

让你的代码读起来就像正常对话一样。

对比Junit中Matchers的使用：

assertThat(x, is(3));
assertThat(x, is(not(4)));
assertThat(responseString, either(containsString("color")).or(containsString("colour")));
assertThat(myList, hasItem("3"));

与传统风格的assertEquals：

assertEquals(3, x);

当我查看该assertEquals声明时，不清楚哪个参数是“预期”，哪个是“实际”。

当我查看时，assertThat(x, is(3))我可以将其用英文读作“断言 x 是 3”，这对我来说非常清楚。

编写自记录代码的另一个关键是用清晰的名称包装方法调用中任何不清楚的逻辑。

if( (x < 3 || x > 17) && (y < 8 || y > 15) )

变成

if( xAndYAreValid( x, y ) )  // or similar...