コードの規則と書式

Cloudflare の製品コンテンツでは、次の規則を使います。

コードブロックの書式ガイドライン

利用者が入力する変数のプレースホルダーを示すときは山括弧を使います（API URL と API 認証ヘッダー は除きます。そちらでは $ZONE_ID / $CLOUDFLARE_API_TOKEN 形式を使います）。プレースホルダーはすべて大文字にし、語の区切りにはアンダースコア（_）を使います。

例:

{
  "description": "<RULE_DESCRIPTION>"
}

https://<YOUR_DOMAIN>.cloudflare.com

省略記号で区切った数字を含む山括弧は、ビットまたは単一の名前に対応する値の範囲を表します。例: AO <0...3>。

角括弧は省略可能な項目を囲みます。

例:

この検索コマンドで始まるサブサーチを指定します: tag=dns query [search tag=malware].

原則として、URL や変数のプレースホルダーに波括弧は使いません。代わりに 山括弧 を参照してください。

特定の API スキーマパスを指すときは、パラメーター名の周りに波括弧を使えます（例: /api/v4/{account_id}）。ただし、API の例（curl ブロックまたは APIRequest ブロック）では、代わりにシェル変数を使います（例: $ACCOUNT_ID）。APIRequest コンポーネントは、API オペレーションの URL パス内の変数を自動で処理します。詳細は cURL コマンドのガイドライン を参照してください。

>

> 記号は、入れ子のメニュー項目とダイアログの選択肢をたどって、最終的な操作へ案内します。Options > Settings > General という順は、Options メニューを開き、Settings を選び、最後のダイアログから General を選ぶことを示します。> 記号自体は太字にしません。

このアイコンは tip を示し、助言情報があることを知らせます。

このアイコンは note を示し、重要な情報があることを知らせます。

このアイコンは info を示し、重要な情報があることを知らせます。

このアイコンは notice を示し、データ損失、信号の完全性の損失、性能低下を避けるための注意を促します。

このアイコンは caution を示し、けがを避けるための注意を促します。

この色のテキストはリンクを示します。

クリック可能な操作を指すときや、UI のタイトルや名前を強調するときに 太字 を使います。太字は、ソフトウェア上で選択またはクリックする項目、UI 上の識別子、パラメーター名を示します。

プログラム名には太字を使いません。

入れ子メニューでは、記号ではなく語を太字にします。

例: Dashboard > This > That

ドロップダウンメニューなど、利用者が選べる選択肢を指すときは イタリック を使います。

トグルの状態を指すときはイタリックにしません。たとえば enabled / disabled はイタリックにしません。

`text in between backticks`

このフォントは、キーボードから入力するテキストや文字、コードの一部分、プログラミングの例、構文の例を示します。ドライブ、パス、ディレクトリ、プログラム、サブプログラム、デバイス、関数、操作、変数、ファイル、API コマンド、拡張子の正式名にも使います。