除了特定于语言的结构之外,对于使用 PHP、javascript、java 和 python 编程的人来说,前 10 项干净编码必须做的事情是什么?我想保持我的代码尽可能干净和可读。例如,将函数体左括号与函数声明放在同一行与换行有何不同?此外,例如 (x==10) 与 (x == 10) 之间的间距是什么?任何有关干净编码的有用提示将不胜感激!
3 回答
这里有一些可能会有所帮助:
- 给变量和方法起直观的名字
- 使用您特定的语言编码风格(例如,在 Java 与 C++ 中,您在括号中使用不同的风格;根据特定的语言约定进行选择)
- 总是对发生什么/为什么发生事情发表评论。
- 但是不要用注释污染代码。
- 如果可以,请尝试集成设计模式。它有助于可重用性和可维护性
- 不要把所有东西都放在一种方法中。每个方法都应该做一件事并且做得非常好(这也使方法更容易阅读/理解/测试/调试)
- 不要在代码中放入硬编码字符串
- 分离应用程序数据和应用程序代码。即尽量不要对您的代码进行硬编码配置。
- 不要试图比编译器更聪明。编写其他人也能理解的代码,并让编译器进行任何优化
- 以显示您的意图的方式编写代码。编写代码保留在您的脑海中,在 7 个月内您可能需要对其进行调试,或者其他人可能需要修复/增强它。7 个月后,你不可能记住你为什么做了某事(评论很好,但有时还不够好)。更不用说那个试图修复你的代码的可怜人了
我相信还有很多,但我相信这些对任何语言都有用
参考:
http://misko.hevery.com/code-reviewers-guide/
http://misko.hevery.com/attachments/Guide-Writing%20Testable%20Code.pdf
并检查此响应中的链接:
https://stackoverflow.com/a/10359288/1268570
观看 Misko Hevery 的简洁代码演讲(提供给 Google 人员)
http://www.youtube.com/watch?v=wEhu57pih5w&feature=player_embedded
http://www.youtube.com/watch?v=RlfLCWKxHJ0&feature=player_embedded
http://www.youtube.com/watch?v=-FRm3VPhseI&feature=player_embedded
http://www.youtube.com/watch?v=4F72VULWFvc&feature=player_embedded
这些是你应该避免的警告信号:(来自 Misko Hevery)
- 构造函数或字段声明中的新关键字
- 在构造函数或字段声明中调用静态方法
- 除了构造函数中的字段赋值之外的任何东西
- 构造函数完成后对象未完全初始化(注意初始化方法)
- 构造函数中的控制流(条件或循环逻辑)
- 代码在构造函数中执行复杂的对象图构造,而不是使用工厂或构建器
- 添加或使用初始化块
- 违反得墨忒耳定律:方法调用链遍历具有多个点 (.) 的对象图
- 添加或使用单例
- 添加或使用静态字段或静态方法
- 添加或使用静态初始化块
- 添加或使用服务定位器
这是一本关于编写干净代码的好书:
http://books.google.com.mx/books/about/Clean_Code.html?id=dwSfGQAACAAJ&redir_esc=y
在我看来,答案是没有真正的答案。一个好的规则是遵守约定,这通常是社区已经熟悉的合理约定。我宁愿建议你几本书有一个想法。
对于 Java/C++/C#/VisualBasic,您应该阅读
在重 Java 方面,您将从
考虑到这两本书中的概念具有普遍的有效性,不应局限于特定的语言。