互联网行业技术部程序员代码编写规范.docxVIP

互联网行业技术部程序员代码编写规范

第1章代码风格规范

1.1命名规范

1.1.1类与接口命名

类名应采用`PascalCase`风格，例如`UserService`或`HttpController`。接口名同样使用`PascalCase`，但需以`I`开头以示区分，如`IUserService`。这种命名方式符合多数开发者的阅读习惯，且能清晰区分实现与抽象。例如，`IUserRepository`作为抽象层，`UserRepository`作为具体实现，这种命名约定在大型项目中能有效降低认知成本。

1.1.2方法命名

方法名应使用`camelCase`风格，并描述其功能。例如`calculateTotalPrice()`或`fetchUserDetails()`。避免使用动词开头如`doSomething()`，而应直接描述操作结果，如`getUserName()`。这种命名方式符合函数式编程的命名传统，且更符合现代API设计原则。例如，`sendNotification()`可以改进为`notifyUser()`，后者更符合RESTful风格。

1.1.3变量命名

局部变量建议使用`camelCase`，并尽可能描述其用途。例如`userList`或`tempFilePath`。静态常量建议使用全大写加