JavaScript编程规范指南：命名与API风格详解

本文档详细介绍了JavaScript编程规范，旨在提升代码的可读性和一致性。核心部分强调了以下几个关键点： 1. **模块和结构命名**: - 模块名应采用小写形式，避免多重语义词，如`module_name`而非`MultipleWords`。 - 类采用骆驼命名规则，如`Account`, `EventHandler`。 2. **命名规则**: - 变量名使用小写字母，如`var myVariable`。 - 私有方法和变量前缀使用下划线，如`_privateMethod`。 - 对象方法遵循混合命名，如`obj.getMethod()`。 - 常量（尤其是枚举）应具有明确含义，如`const ENUM_NAME = { ... }`。 3. **方法和参数**: - 方法命名使用动词或动词短语，如`obj.getValue()`。 - 公共方法也采用混合命名，如`obj.somePublicFunction()`。 - 参数名称采用小写混合，如`function myFunction(paramName) {}`。 4. **CSS变量与类的关联**: - CSS变量名与公共类变量保持一致。 - 私有类变量属性使用下划线前缀，如`var MyClass = function() { var _buffer; }`。 5. **访问控制**: - 私有变量和属性前加下划线，表示只能在类内部访问，如`this._somePrivateVariable = statement;`。 - 全局变量用于作用域较大时，可以设计为类成员。 6. **类型明确**: - 变量名和类型保持一致，如`setTopic(topic: Topic)`，表明`topic`是`Topic`类型的变量。 7. **语言限制**: - 避免大写字母命名，除非在简写或特定上下文中。 - 使用英文命名，确保跨平台兼容性。 遵循这些编程规范有助于提高代码的可读性、可维护性和团队协作效率，确保项目开发过程中的一致性。