你如何编写其他人手写的代码,而这些代码中没有任何人可以编写代码？

Question

你如何编写易于被其他人阅读的代码,并且没有编写任何部分的代码？

Answer 1

确保其他人可以阅读您的代码的最佳方法是确保其清晰简洁.也就是说,

• 为变量,函数和类使用自记录名称.
• 评论复杂的算法,以便读者不必花费很长时间来弄清楚它的作用.
• 确保标签和换行符在整个代码中保持不变.

除此之外,你开始进入可能有点主观的领域,大多数人应该同意这些项目.

Answer 2

这个问题是主观的,应该根据常见问题解答在StackOverflow上避免

我不应该在这里问什么样的问题？

避免提出 主观,议论或需要进行深入讨论的问题.这是一个可以回答问题的地方!

简短的回答是:

• 避免过多评论:

  // add one to the count:
  i++;
  

• 使用好的变量和方法名称:

  int x = i + j;
  int runSum = prevSum += newValue;
  

• 在可用的地方使用编码速记:

  if (x == y)
  {
    z = a;
  }
  else
  {
    z = b;
  }
  z = (x == y) ? a : b;
  

Answer 3

您可能想看看Robert C. Martin的Clean Code.它提供了许多有用的实践来确保您的代码可读.

此外,如果您的代码受到许多彻底测试代码的单元测试的支持,它为用户提供了一种通过查看测试正在进行的操作来理解代码的方法.您还会发现,如果您遵循测试驱动开发过程,并且您为每个功能部分编写测试,那么您的功能往往很小,只做一件事并做得很好,而且往往更像是一个故事,而不仅仅是一个故事.一个庞大的复杂的"东西"网络.

测试往往比评论更新.我经常忽略评论,因为它们很快就会过时.

Answer 4

保持代码美观、清晰、简单。当事情显而易见时，不要评论你正在做的事情（例如，我知道 foreach 或 if 的作用，我通常不需要解释）。

使简单的事情占用更少的行的代码技巧（例如自动属性）也很好。