用途:为 Shopify 主题代码提供 HTML 结构、数据属性与注释的编写规范,适用于在 section 中组织 HTML 标记、通过属性向 JavaScript 传值、为 Liquid 模板添加注释、整理 HTML 元素等场景。
主要能力与用法: HTML 与数据属性:可用自定义 HTML 标签配合 JavaScript 自定义元素提升语义;通过 data-* 属性传递动态数据,命名使用 kebab-case(如 data-product-id),在 JavaScript 中经 dataset 属性读取,attribute 名转为驼峰(this.dataset.productId)。data 属性也用于把 Liquid 中的配置传入 JavaScript,例如 data-autoplay、data-interval、data-transition,需在 JS 中自行转换类型,如 this.dataset.autoplay === 'true'、parseInt(this.dataset.interval, 10)。
注释:注释应保持精简,只标注非显而易见的逻辑,解释“为什么”而非“什么”。Liquid 使用 {%- comment -%} 与 {%- endcomment -%},或 {% liquid %} 标签。snippet 必须写使用说明注释,例如 {% render 'product-card', product: product, show_vendor: true, show_price: true %}。HTML 注释仅少量用于区块组织。需要注释的情况:复杂业务逻辑、非显然的计算、绕过问题的权宜写法、snippet 用法说明、section 级文档;不需要注释的情况:显然的代码、逐行注释、自解释的变量名、标准 Liquid 语法。
结构与可访问性:使用语义化 HTML 元素(article、header、footer 等);添加无障碍属性,如 aria-label 与图片 alt。资料还列出官方参考方向:HTML Elements、Data Attributes、Web Accessibility、Shopify Theme Structure。
限制:资料未提供安装命令、收费方式、支持平台与效果数据,暂未提供。