HTML5/JavaScript编程规范详解

0 下载量 152 浏览量 更新于2024-08-29 收藏 59KB PDF 举报
"我的HTML5/JavaScript编程规范" 在HTML5和JavaScript编程中,遵循一套良好的编码规范至关重要,因为它可以提高代码的可读性、可维护性和团队协作效率。以下是一些从提供的信息中提取的关键规范点: 1. **文本编辑规则**: - 缩进使用2个空格,避免使用制表符(tab),这有助于保持代码的一致性。 - HTML标签全部使用小写字母,例如`<input type="checkbox" checked>`。 2. **命名规范**: - 函数和变量名应以小写字母开头,中间使用骆驼命名法,例如`getElementById()`。 - 类似宏的函数名称全小写或全大写,用下划线分隔单词,如`extend_class__`。 - 类名以大写字母开头,如`function MyObject()`。 3. **作用域和可见性**: - 对外公开的类名以大写字母开头,如`MapPoint`。 - 内部使用的类名以双下划线`__`开头并加上大写字母,如`__ViewPort`。 - 类的公有方法或属性遵循函数和变量的命名规则,例如`mapPoint.getDistance`。 - 私有方法或属性以单下划线`_`加小写字母开头,只允许内部访问。 - 更私有的方法或属性,以双下划线`__`加小写字母开头,例如`__salaryAmount`。 - 类的静态变量也以大写字母开头,如`MapPoint.MaxRadius`。 4. **注释规范**: - 单行注释使用`//`,多行注释使用`/* ... */`。 - 短注释可以使用单行注释`//`。 - 以`//?`开头的注释表示未完成的临时代码。 - 给属性添加注释时,使用`//@attributeName`格式。 5. **JavaScript类模板**: - 提供了一个JavaScript类模板,示例中使用了类似C#的`usingScript`语句来引入其他JS文件,这可能表示某种自定义的加载机制。 - 类的定义通常包含文档注释,提供类的功能描述,例如`$MyClassBase`。 遵循这些规范可以创建结构清晰、易于理解和维护的代码。在实际开发中,还可以结合其他最佳实践,例如模块化(使用ES6的import/export或CommonJS的require),以及使用linter工具(如ESLint)自动检查和修复代码风格问题。