为了确保代码质量和可维护性,我们制定了以下代码风格指南。请务必遵守以下规则。
通用规则
- 使用一致的缩进风格,推荐使用 4 个空格。
- 函数和类名应使用驼峰命名法(camelCase)。
- 变量名应使用小写字母,单词之间使用下划线分隔。
- 常量名应使用全大写字母,单词之间使用下划线分隔。
代码格式
- 代码块应使用三个反引号(````)包裹,例如:
function helloWorld() {
console.log('Hello, World!');
}
- 单行代码应使用分号(;)作为结束符,多行代码应省略分号。
注释
- 代码应包含必要的注释,以帮助他人理解代码逻辑。
- 注释应简洁明了,避免冗余。
- 代码块前应添加简要说明。
图片示例
下面是一个使用图片的示例:
<center><img src="https://cloud-image.ullrai.com/q/Golden_Retriever/" alt="Golden Retriever"/></center>
扩展阅读
更多关于代码风格的指南,请访问本站代码风格指南页面。