概述
本文档定义了HTML/CSS的编译格式和样式规则。 它致力于改善协作、代码质量和支持基础设施。 适用于 HTML/CSS 文件,包括 GSS 文件。 只要能够保持代码质量,就可以很容易地通过工具进行混淆、压缩和合并。
风格规则合同
嵌入资源写入省略合约头
/* 不推荐 */ .example { background: url(http://www.google.com/images/example); } /* 推荐 */ .example { background: url(//www.google.com/images/example); }
排版规则缩进
每个缩进是两个空格。
案件
仅使用小写字母。
尾随空格
删除尾随空格。
元数据规则编码
采用 UTF-8 编码,无 BOM 标头。
让您的编辑器以不带字节顺序标记的 UTF-8 编码进行编译。
指定 HTML 模板和文件中的编码。 无需指定样式表的编码,默认为UTF-8。
(有关编码以及如何指定编码的更多信息,请参阅 XHTML、HTML 和 CSS 中的字符集和编码。)
笔记
尽力解释你编写的代码。
使用注释来解释代码:它包含什么,它的目的是什么html 指定编码,它做什么,你为什么使用这个解决方案,或者它只是出于喜爱?
(这条规则是可选的,没有必要完整描述每一段代码。它会增加HTML和CSS代码的权重。这取决于项目的复杂程度。)
活跃项目
使用 TODO 标记待办事项和活动条目
仅使用 TODO 来指示要做的事情。 请勿使用其他常见格式,例如@@。
在括号中附加联系人(用户名或电子邮件列表),例如 TODO(联系人)。
活动项描述可以附加在引号后,例如 TODO:活动项描述。
{# TODO(cha.jn): 重新置中 #} Test
- Apples
- Oranges
HTML代码样式规则文档类型
请使用 HTML5 标准。
HTML 代码有效性
尝试使用有效的 HTML 代码。
编写有效的HTML代码html 指定编码,否则很难实现性能提升。
使用W3CHTML验证器之类的工具来测试它。
HTML代码的有效性是一个重要的质量标准,保证HTML代码能够被正确使用。
Test This is only a test. Test This is only a test.
语义学
根据其用途使用每个 HTML 元素。
使用元素(有时被错误地称为“标签”)来了解您使用它们的原因以及它们是否正确。 例如,heading元素用于构造标题,p元素用于构造段落,a元素用于构造锚点等。
根据用途使用每个 HTML 元素非常重要,这涉及文档可访问性、重用性和代码效率等问题。
All recommendationsAll recommendations
多媒体备份计划
提供多媒体的替代内容。
对于通过画布读取的图像、视频、动画元素等多媒体,请确保提供替代方案。 对图像使用有意义的替代文案 (alt),对视频和音频使用有效的文案和标题。
提供替代内容很重要,原因如下:为盲人用户提供一些信息性文本,使用@alt告诉他们图像的内容,并为可能不理解视频或音频内容的用户提供提示。
(图片的alt属性会变得多余,如果图片只是用于装饰,不能立即用CSS使用,则无需使用替代副本。可以写alt=""。)
发表评论