编程标准
Solsynth 是做软件出家的,因此 Solsynth Works 的编程标准尤为重要。 我们制定了一套编程标准,以确保代码的质量、一致性和可维护性。
我们采用统一的代码风格指南,以确保代码在整个项目中保持一致。
- 括号
- 使用 K&R 风格的括号。
- 函数定义和控制结构的左括号应与关键字在同一行。
- 例如:
if (condition) {// code} else {// code}
- 缩进
- 使用 4 个空格进行缩进。
- 不要使用制表符(Tab)。
- 命名约定
- 变量和函数名使用驼峰命名法(camelCase)。
- 特殊语言(比如 C#)遵循其社区惯例。
- 常量使用全大写字母和下划线分隔(例如:
MAX_VALUE)。- 对于 C#,使用 PascalCase(例如:
MaxValue)。 - 对于 Dart,使用驼峰命名法并在开头添加一个 k(例如:
kMaxValue)。
- 对于 C#,使用 PascalCase(例如:
- 变量和函数名使用驼峰命名法(camelCase)。
- 注释
- 我们 Solsynthizers 都自认为是有良好代码习惯,并且总是撰写 Clean Code。
- 因此,我们习惯不在代码上加注释,除非是非常复杂的逻辑或算法,或者有特殊的处理逻辑。
- 我们这么做的依据是我们的代码即注释,并且如果 AI 都能理解我们的代码,如果你理解不了, 那就说明你需要提升你的编程能力。
- 对于外来贡献者,假如 Solsynthizers 在 Review 你的 Code 时看不懂你在写什么,并且 你又没有添加注释,那么我们建议你提升你的编程能力,然后 Close 掉那个 PR 洗洗睡。
虽然 Over Engineering 不好,但是 Solsynthizers 们也应当追求优雅和高效的代码实现。 而且根据我们目前的 Team Leader 的喜好来看,如果你在搭建一个系统(例如帐号激活代码)时 可以被别处服用(例如密码重置代码服用上述的数据结构和功能),那么你应该考虑在搭建其时 保留足够的扩展性,包括但不限于:
- 使用中性的命名方法
- 避免使用过于具体的名称,确保代码可以在不同场景下复用。
- 模块化设计
- 将功能拆分为独立的模块,便于维护和复用。
- 足够的可配置项
- 提供配置选项,以适应不同的使用场景。