17.使用注释

• 注释是一个很好的做法。
• 不要对一切代码发表注释。相反，我们可以使用类、函数、方法、变量等有意义的单词编写描述性代码。
• 删除注释代码、误导性注释和故事型注释。
• 我们可以使用注释进行警告，并解释一些乍一看难以理解的内容。

18.对类、方法、函数、变量和其他属性使用有意义的词语。

• 这看起来很简单，但影响却是巨大的。
• 始终使用正确的有意义且可搜索的命名约定以及正确的大小写。
• 通常，我们在声明类、变量和常量时使用名词或短语。例如：字符串 firstName，const isValid
• 我们可以使用带有形容词的动词和短语来表示函数和方法。例如：readFile()、sendData()
• 避免使用缩写变量名和意图揭示的名称。例如： int i;字符串 getExUsr;
• 如果我们有意义地使用此功能，则可以减少声明注释行。由于它具有有意义的名称，新开发人员可以通过阅读代码轻松理解。

19.使用正确的大小写进行声明

• 有许多不同的大小写，如大写、小写、驼峰命名、帕斯卡命名、蛇命名、大蛇式命名、短横线命名等。

• 但我们需要确定哪个案例专用于哪个变量。

• 通常我会遵循如下方式，

  类 — 帕斯卡命名

  方法和变量 — 驼峰命名

  常量 — 大蛇式命名

  数据库相关字段 — 短横线命名

  这只是一个例子,它可能与我们在公司遵循的标准不同。

20.简单点

• 始终尝试编写简单、可读的代码。
• 同样简单的逻辑可以用不同的方式实现，但是如果不可读或不理解就很难理解。
• 有时复杂的逻辑会消耗更多的内存。
• 编写代码时尝试使用 KISS、DRY 和 SOLID 原则。我将在以后的文章中解释这一点。

21.使用通用的代码格式样式

• 格式样式因开发人员而异。编码风格的改变也被认为是一种改变，并且会使代码合并变得非常困难。
• 为了避免这种情况，团队可以采用通用的编码格式。

22.使用 SonarLint 插件

• 这对于识别小错误和最佳实践非常有用，以避免不必要的错误和代码质量问题。
• 我们可以将插件安装到我们最喜欢的 IDE 中。

最后

至此本文讲解内容到此完毕感谢阅读，希望本文能对你有所帮助。

关注公众号【waynblog】每周分享技术干货、开源项目、实战经验、高效开发工具等，您的关注将是我的更新动力！