Beta阶段代码规范

这个作业属于哪个课程	2301-计算机学院-软件工程
作业要求	团队作业—beta冲刺+事后诸葛亮
作业目标	Beta阶段代码规范
团队名称	洛杉矶耐摔亡
团队置顶随笔

---

前端代码规范

一、项目命名规范

全部采用小写方式，以中线分隔

二、目录命名规范

全部采用小写方式， 以中划线分隔，有复数结构时，要采用复数命名法， 缩写不用复数。

三、JS、CSS、HTML规范

1.HTML规范

1.多特性分行写
为提高可读性，组件应用时换行，按照ref、class、传入、传出顺序书写
2.避免重复
避免过多重复代码

2.css规范

1.命名规范：使用有意义的、描述性的类和ID名称。遵循一致的命名约定，例如使用中划线分隔符（如：.button-style）或驼峰命名法（如：.buttonStyle）。

2.缩进和空格：使用一致的缩进风格，通常是使用四个空格或一个制表符。在选择器、属性和值之间使用空格，以提高可读性。

3.注释：在代码中添加注释，解释代码的目的和用途。注释应该清晰、简洁，并且提供有帮助的上下文信息。
4.代码组织：按照一定的逻辑顺序组织CSS属性。可以根据盒模型、布局、字体、颜色等属性进行分组。同时，对于较大的项目，可以考虑使用模块化的CSS结构，如使用BEM（Block-Element-Modifier）或其他类似的方法。

3.JS规范

1.缩进和空格：使用一致的缩进风格，通常是使用四个空格或一个制表符。在语句之间使用空格，使代码更易读。

2.命名规范：使用有意义的、描述性的变量和函数名称。遵循一致的命名约定，例如使用驼峰命名法（如：myVariable）或下划线分隔符（如：my_variable）。

3.注释：在代码中添加注释，解释代码的目的和用途。注释应该清晰、简洁，并且提供有帮助的上下文信息。注释可以用于解释算法、特殊处理、重要的业务逻辑等。

4.变量声明：始终使用let或const关键字声明变量，避免使用隐式全局变量。尽可能在使用变量之前声明，并将变量的作用域限制在最小范围内。

5.函数：使用有意义的函数名称，函数名使用驼峰命名法。函数应具备单一责任原则，避免函数过于庞大和复杂。函数应有清晰的输入和输出，避免对外部状态产生副作用。

6.条件语句和循环：在条件语句和循环中使用花括号（{}）包裹代码块，即使只有一行代码。这有助于提高代码的可读性和减少错误。

7.错误处理：对可能出现错误的操作进行适当的错误处理，使用try…catch块捕获和处理异常。避免使用空的catch块，至少在catch块中打印或记录错误信息。

8.模块和模块化：使用模块化的开发方式，尽可能将代码分割成独立的模块，每个模块负责特定的功能。使用ES6的模块语法（import和export）或其他模块系统来管理模块之间的依赖关系。

9.代码格式化和风格：遵循一致的代码格式化和风格，使用适当的缩进、空格、换行和括号的使用。可以使用代码格式化工具（如Prettier）来自动化代码格式化的过程。

四.命名严谨性规范

代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 即使纯拼音命名方式也避免采用，杜绝完全不规范的缩写，避免望文不知义。

五.风格规范

1.建议统一使用单引号’', 而不是双引号""，以保持风格一致性。
2.在代码块的开头和结尾，建议生成一个新行，增加代码的可阅读性。
3.HTML缩进使用 2 个空格（一个 tab），嵌套的节点应该缩进。
4.在每一个块状元素，列表元素和表格元素后，加上一对 HTML 注释。

后端代码规范

一.变量命名规范·

1.使用有意义的名称：变量名应该能够清晰地描述其用途和含义。避免使用过于简单或无意义的命名，而是选择具有描述性的名称，以便其他开发人员能够更容易地理解代码。

2.遵循命名约定：选择一种命名约定并坚持使用。常见的命名约定包括驼峰命名法（camelCase）和下划线分隔符命名法（snake_case）。无论选择哪种约定，都应该保持一致性。

3.避免使用缩写和简写：尽可能避免使用过多的缩写和简写，以确保代码的可读性。变量名应该是易于理解的单词或短语，避免使用晦涩难懂的缩写。

4.使用具体的名称：尽量使用更具体的名称，以便于理解变量的含义。例如，使用totalPrice而不是price来表示总价格。

5.避免使用保留字：避免使用JavaScript或特定编程语言中的保留字作为变量名，以免引起命名冲突和错误。

6.一致性：在整个代码库中保持一致的命名风格。如果已经存在一种命名约定，应该在代码中保持一致，以减少混淆和错误。

7.避免过长的变量名：虽然变量名应该具有描述性，但也要避免过长的变量名，以免降低代码的可读性。选择长度适中的变量名，能够准确传达变量的用途。

8.注释和文档：如果变量的含义不明显或需要额外的解释，可以使用注释或文档来提供更多的上下文和解释。

二.类的编写规范

1.每个.java文件中只应该有一个顶级类或接口。如果需要定义辅助类，可以考虑作为内部类。
2.类的方法顺序放置推荐是：公有函数或保护函数 -> 私有函数 -> Getter/Setter -> Override函数。

三.注释规范

1.类、类属性、类方法的注释必须使用Javadoc规范，使用/内容/格式，不得使用//xxx方式。
2.所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
3.所有的类都必须添加创建者信息。
4.选择一种注释风格并坚持使用。常见的注释风格包括单行注释（//）和多行注释（/ */）。单行注释适用于简短的注释或行内注释，而多行注释适用于较长的注释块。
5.注释应提供有用的上下文信息和解释。注释应该解释代码的意图、实现细节、特殊处理、算法逻辑等。避免写出显而易见的注释，注重解释代码背后的原因和思路。
6.注释应与代码保持同步并及时更新。当代码发生变化时，特别是在修复bug、添加新功能或进行重构时，务必更新相关的注释，以保持注释的准确性。
7.尽量保持注释简洁明了，不要写过长的注释。对于较长的注释，可以使用适当的格式和标记，如段落分隔、列表、引用等，以提高可读性。
8.在注释中使用特殊标记（如TODO、FIXME、NOTE等）可以帮助标识需要进一步处理或关注的部分。这些标记可以帮助开发人员在日后快速定位和处理相关问题。

四.异常处理规范

1.业务代码不应直接抛出异常，而应通过日志记录，由框架统一处理。
2.捕获异常应该使用更具体的异常类，如 FileNotFoundException 而不是 Exception 或 RuntimeException。
3.避免在catch块中什么都不做，或只是简单地吞噬异常。至少在catch块中记录异常信息，以便能够追踪和排查问题。
4.据需要和代码结构，可以使用多层的异常处理机制。例如，在较高的层次捕获和处理通用的异常，而在更低的层次处理特定的异常。
5.涉及事务和数据库操作的情况下，适时进行异常恢复和回滚操作，以确保数据的一致性和完整性，有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。
6.在团队中定义一致的异常处理策略和准则，以确保代码的一致性和可读性。这可以包括异常命名规范、异常处理流程等。

五 .SQL规范

1.选择有意义且描述性的表名，使用小写字母和下划线分隔单词。避免使用保留字作为表名，并尽量避免过长或过于简短的表名。

2.选择有意义且描述性的列名，使用小写字母和下划线分隔单词。避免使用保留字作为列名，并尽量避免过长或过于简短的列名。

3.根据数据库的设置，了解SQL语句是否区分大小写。对于大小写不敏感的数据库，建议使用统一的大小写规范以提高代码的可读性。

4.对SQL语句进行适当的缩进和格式化，以提高可读性。按照约定的缩进规则对关键字、表名、列名、运算符等进行对齐和分组。

5.对SQL语句进行注释，解释其目的、逻辑或其他重要信息。这有助于团队中的其他开发人员理解和维护代码。

6.对于动态生成的SQL语句，使用参数化查询而不是直接拼接字符串。这可以减少SQL注入攻击的风险，并提高查询的安全性。

7.对于需要一致性和完整性的操作，使用事务进行处理。在事务中，可以执行一系列SQL操作，并确保它们要么全部成功，要么全部回滚。

8.根据查询的需求和数据模型，合理地创建索引以提高查询性能。了解数据库的查询优化技术，并使用合适的查询语句和优化方法。

9.避免频繁使用子查询，而是使用JOIN操作来联接多个表。JOIN操作通常比子查询效率更高。

10.不等条件（!=、<>、NOT）不走索引，应尽量避免（转换成IN/BETWEEN等）

11.确保在SQL语句中对敏感信息（如密码）使用适当的加密或哈希算法，以保护数据的安全性。

12.SQL中的参数类型确保与列定义一致，避免数据库隐式转换开销且无法使用索引。

13.列定义为日期类型，参数要转换为Date日期类型进行比较。