编码需要遵守的规范之算法设计与分析课

9月9号的课后作业是网上搜索大公司的内部编码规范，列出你本学期编码需要遵守的规范。

 

我使用了微软浏览器的搜索和千问ai网页对话进行网上搜索工作。

通过浏览器搜索，我找到了京东的前端代码指南（https://guide.aotu.io/index.html）、百度的JavaScript编码规范（https://ucc.alicdn.com/images/user-upload-01/img_convert/c253ec9a975c5cdd2d02a57a36dd1ba3.png）等等。

千问ai则为我总结如下： 1. 命名规范 命名是代码可读性的基础，大厂普遍遵循“见名知义”的原则，严禁使用拼音、中文或无意义的缩写。 类名与接口：通常采用大驼峰命名法（PascalCase），如 UserService、IUserRepository。抽象类常以 Abstract 或 Base 开头，异常类以 Exception 结尾。 变量与方法：通常采用小驼峰命名法（camelCase），如 userName、getUserInfo。 常量：全部大写，单词之间用下划线分隔，如 MAX_PAGE_SIZE。 私有成员：在某些语言（如C#）中，私有字段会在开头添加下划线（如 _customerCount）以明确访问级别。 2. 代码格式与布局 统一的代码格式能极大降低阅读成本。 缩进与空格：统一使用4个空格（Java等）或2个空格（C#等）进行缩进，严禁Tab与空格混用。 行长度：单行代码长度通常建议不超过80-120个字符，超长需换行。 大括号：使用大括号定义代码块，且不可省略，即使块内只有一条语句。 空行与换行：逻辑块之间空一行，每个独立语句占一行，禁止连续多行空行或一行多句。 3. 注释规范 注释的核心原则是解释“为什么这么做”而非仅仅描述“做了什么”。 文档注释：类、接口、公共方法必须添加标准文档注释（如Javadoc），包含功能描述、参数、返回值及异常说明。 行内注释：在复杂逻辑处添加注释说明设计思路，禁止冗余注释（如 // i++ 表示增加1）和过时注释。 特殊标记：使用 TODO 标记待完成功能，FIXME 标记需修复的问题。 4. 异常处理与安全规范 异常捕获：必须捕获具体的异常类型，严禁捕获万能异常或留下空的 catch 块。异常处理需记录日志或抛出明确异常。 资源管理：资源使用后必须关闭，推荐使用 try-with-resources 等安全机制。 安全防御：防范SQL注入（使用预编译语句）、XSS攻击（输出转义）；禁止硬编码敏感信息（如密码、密钥），需通过配置中心获取。 5. 架构设计与工程实践 单一职责：每个类或方法应专注于单一职责，避免代码耦合。 依赖注入：大型项目中广泛使用依赖注入模式，使代码解耦并便于单元测试。 防御性编程：所有外部输入必须经过白名单校验，敏感字段强制脱敏，异步任务需具备幂等性。 6. 版本控制与测试 分支管理：主分支仅存放发布代码，开发在 develop 分支进行，功能分支命名为 feature/*，修复分支命名为 bugfix/*。 提交规范：提交信息格式通常为“类型:描述”（如 feat:新增用户注册、fix:修复登录异常）。 单元测试：代码必须包含充分的单元测试，且测试覆盖率需达到企业规定的硬指标（如≥65%）。

 

根据以上内容，我为自己总结了以下几点编码规范：

1.命名规范，根据变量代表内涵使用驼峰命名法进行命名，方便自己可以轻松通过变量名知道这个变量代表的是什么

2.规范使用缩进，保持代码美观易读

3.进行必要的注释，方便自己阅读代码

4.根据课程内容进行补充