软件行业技术部工程师代码编写规范手册.docxVIP

软件行业技术部工程师代码编写规范手册

第1章项目编码与命名规范

1.1项目整体编码规则

统一采用语义化命名原则，将业务含义直接融入标识符中，避免使用xxx_id或xxx_name等无意义后缀，例如将用户表命名为user_info而非userinfo，便于后续快速定位业务逻辑。遵循全局唯一性约束，所有表名、类名、常量名需通过命名空间隔离，防止命名冲突，例如在SpringBoot项目中，将Controller类命名为UserController而非Controller，确保路径映射清晰且无歧义。

引入PascalCase或camelCase两种主流风格，PascalCase用于类名和常量（如UserProfile），camelCase用于变量和方法名（如getUserProfile），同时规定所有内部类必须使用PascalCase，以区分内部组件与外部对象。严格区分私有与公共访问权限，类内部的所有成员变量和方法默认使用private修饰，仅在需要外部调用时通过public声明，如privateStringpassword，杜绝外部类直接访问敏感数据导致的安全风险。强制使用小写字母+下划线分隔单词，禁止使用连字符（-）或下划线（_），例如将my-user-name改为my_user_name，保持代码风格的一致性并提升可读性。