Magento的核心开发人员必须遵循的Magento代码划分标准.
本标准推荐给第三方扩展开发者。
Magento代码的某些部分可能不符合标准,但是我们正在逐步完善。
该标准是在我们的努力范围,以确保以下:
使用RFC 2119 解读 “MUST,” “MUST NOT,” “REQUIRED,” “SHALL,” “SHALL NOT,” “SHOULD,” “SHOULD NOT,” “RECOMMENDED,” “MAY,” 和 “OPTIONAL” 关键字.
语义
属性的名称和值必须使用有意义的单词由拉丁字母缩写的字母和连字符连接(-
)
可接受的
不可接受的
语义表示依赖于id属性
不可接受的PHTML,JavaScript和CSS文件的组合,
JavaScript 文件
CSS 文件
您必须仅使用语义HTML标记,并且不能使用呈现标记。
可接受的:
不可接受的:
代码划分
可接受的CSS选择器
不可接受的CSS选择器
你不能硬编码CSS样式在JavaScript文件
可接受的JavaScript文件
不可接受的JavaScript部件文件
可接受PHTML模板
不可接受PHTML模板
magento 2核心开发团队使用PSR-1: 基本的编码标准 和 PSR-2: 编码风格指南标准开发。 Magento 2推荐开发者开发和定制扩展也使用这些标准。
类名解析标准
例子:
这种风格指南定义为团队开发Magento少和CSS代码的HTML代码风格的内在要求。我们建议开发者Magento的扩展和定制也使用这些标准。
缩进
只使用空格缩进:
Tab: 4 空格
缩进大小: 4 空格
延续缩进: 4 空格
推荐
文件结束
在文件的结尾添加空白行。
总是关闭自关闭标签。
不恰当的
推荐的
行长
避免代码行长于120个字符。使用编辑器时,浏览HTML代码时,向左和向右滚动是不方便的。将标记属性按比例排列以增加代码可读性。
不恰当的
推荐的
等于号周围的空间
不推荐的
推荐的
属性后面的空格
不推荐的
推荐的
元素级别如下图:
css类名称
不恰当的
推荐的