Joplin 编码风格

Joplin 应用程序是一个开源项目,它是一个跨平台的记事本和笔记应用程序。该项目正在不断更新和改进,并已成为许多人选择的最佳笔记应用程序之一。要让代码在整个项目中具有一致的风格,Joplin 开发团队采用了一些编码规则。下面将为您介绍 Joplin 的编码风格。

文件命名

Joplin 应用程序的源代码必须使用英语撰写,并使用连字符 (-) 将单词连接起来。文件名应该尽可能地简洁和清晰,无需包含冗长并且无用的单词。

缩进

Joplin 应用程序的每一个缩进必须使用四个空格。请勿使用 Tab 字符。

变量和函数命名

变量和函数命名必须清晰、简洁、和描述性。名称中的每个单词必须使用小写字母,并使用下划线 (_) 连接前缀和实际名称。请勿使用简写或缩写。

大括号位置

Joplin 应用程序的大括号必须始终位于流程控制语句相应语句的下一行。

空格

在 Joplin 应用程序中,运算符周围必须包含空格,包括等号、加号、减号、除号和乘号。 函数和左括号之间必须有一个空格。在每个逗号后必须有一个空格,除非逗号位于一行的结尾。

代码长度

Joplin 应用程序的每行代码应该尽可能地短。每行代码不能超过 80 个字符。

注释

Joplin 应用程序的注释应该简洁明了,能够让其他开发者更好地理解代码。在注释中,必须避免使用过多的技术术语和行业术语,而应该使用简单清晰的语言,方便所有人能够理解。

这些就是 Joplin 的编码风格。如果您在开发 Joplin 应用程序时遵循这些规则,那么您的代码将会更有条理,更容易阅读和维护。同时,这也是贡献代码给 Joplin 项目的最佳实践。我们期待你加入我们,成为 Joplin 开源项目发展历程的一部分。

详情参考

了解更多有趣的事情:https://blog.ds3783.com/