📘 公式リファレンス🏷️ リファレンス/タグ中級
doc タグ(テンプレートの注釈・ドキュメント)
Liquid テンプレート内にドキュメンテーションコメントを埋め込むタグ。`{% doc %}` ~ `{% enddoc %}` に囲まれたコンテンツは画面に出力されず、内部の Liquid コードは解析されるが実行されない。コード補完、リンティング、インラインドキュメント機能の実装を支援する。
用途
スニペットの引数や機能を JSDoc 形式で記述し、IDE やテーマカスタマイザーで開発者向けの補完情報を提供するとき。テンプレート内の処理内容をドキュメント化したいとき。
設置場所
スニペット(例:snippets/message.liquid)の先頭に `{% doc %} ... {% enddoc %}` で囲んで記述する。`@param`、`@example` など LiquidDoc 形式のアノテーションを記載し、IDE の補完機能や管理画面での説明表示に反映させる。
注意点
doc タグ内のコンテンツは描画されないため、ドキュメントの正確性はテンプレート実装者が保証する必要がある。LiquidDoc 形式の詳細仕様は Shopify 公式の LiquidDoc リファレンスを参照し、アノテーション記法(`@param`、`@example` など)を厳密に守ることで初めて IDE やビルドツールが正しく解析できるようになる。
仕様
12 行 / json{
"category": "syntax",
"deprecated": false,
"deprecation_reason": "",
"description": "The `doc` tag allows developers to include documentation within Liquid\ntemplates. Any content inside `doc` tags is not rendered or outputted.\nLiquid code inside will be parsed but not executed. This facilitates\ntooling support for features like code completion, linting, and inline\ndocumentation.\n\nFor detailed documentation syntax and examples, see the\n[`LiquidDoc` reference](/docs/storefronts/themes/tools/liquid-doc).",
"parameters": [],
"summary": "Documents template elements with annotations.",
"name": "doc",
"syntax": "{% doc %}\n Renders a message.\n\n @param {string} foo - A string value.\n @param {string} [bar] - An optional string value.\n\n @example\n {% render 'message', foo: 'Hello', bar: 'World' %}\n{% enddoc %}",
"syntax_keywords": [],
"examples": []
}出典・ライセンス
- Repository:
- https://github.com/Shopify/theme-liquid-docs
- License:
- MIT
このコードは Shopify 著作の MIT ライセンスソースです。 原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。
関連項目
📘 公式リファレンス🏷️ リファレンス/タグ初級
include タグ(スニペットを埋め込む)
スニペットファイルを Liquid テンプレート内に埋め込んでレンダリングする。埋め込み先の変数にアクセス・変更できるため、親テンプレートと子スニペット間でデータを直接共有する。
📁 theme-liquid-docs·MIT·17 行
📘 公式リファレンス🏷️ リファレンス/タグ中級
javascript タグ(セクション・ブロック内のコード)
セクション、ブロック、スニペット内に JavaScript コードを記述するタグ。このタグ内に書いた JavaScript は Shopify のテーマビルドシステムにより自動的に読み込まれて実行される。
📁 theme-liquid-docs·MIT·17 行
📘 公式リファレンス🏷️ リファレンス/タグ初級
sections タグ(セクショングループを描画)
セクショングループをテーマのレイアウト内で描画するタグ。レイアウトファイル内に配置して、複数のセクションをグループ化した内容を出力する。
📁 theme-liquid-docs·MIT·17 行
📘 公式リファレンス🏷️ リファレンス/タグ初級
stylesheet タグ(CSS定義)
セクション、ブロック、スニペット内で CSS スタイルを定義するタグ。各ファイルにつき1つだけ記述でき、定義した CSS はそのコンポーネント固有の外側スコープで読み込まれて実行される。
📁 theme-liquid-docs·MIT·17 行
📘 公式リファレンス🏷️ リファレンス/タグ初級
break タグ(ループの中断)
for ループの反復処理を途中で停止するタグ。指定した条件に達したら以降の反復をスキップして、ループを抜ける。
📁 theme-liquid-docs·MIT·23 行
📘 公式リファレンス🏷️ リファレンス/タグ初級
continue タグ(ループをスキップ)
for ループ内で現在の反復をスキップし、次のイテレーションに進ませる。条件分岐で特定の要素の処理を除外するときに使う。
📁 theme-liquid-docs·MIT·23 行