本页介绍了我们网站的代码规范,旨在确保代码质量、可维护性和一致性。
语言风格
- 中文:默认语言风格,适用于大多数用户。
- English:适用于英语用户,访问路径如
/en/代码规范
。
规范内容
通用规范
命名规范
- 变量、函数和类名使用驼峰式命名法。
- 常量使用全大写字母,单词间用下划线分隔。
注释规范
- 代码应包含必要的注释,解释代码的意图和功能。
- 注释应简洁明了,避免冗余。
代码格式
- 使用一致的缩进和空格。
- 避免过长的行,通常不超过80个字符。
语言特定规范
JavaScript
- 使用 ES6+ 语法特性。
- 避免使用全局变量,使用模块化开发。
Python
- 使用 PEP 8 编码规范。
- 尽量使用内置函数和库。
图片示例
JavaScript 代码示例
function add(a, b) { return a + b; }
Python 代码示例
def add(a, b): return a + b
扩展阅读
图片插入
JavaScript 代码示例图片
Python 代码示例图片