readability - 如何编写能让其他没有参与编写任何部分的人轻松阅读的代码？

Question

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

Answer 1

确保其他人可以阅读您的代码的最佳方法是确保它清晰简洁。即，

• 对变量、函数和类使用自记录名称。
• 对复杂的算法进行注释，这样读者就不必花很长时间弄清楚它的作用。
• 确保整个代码中制表符和换行符保持不变。

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