コード規約とフォーマット
Cloudflare製品のコンテンツ全体で、以下に記載された規約を使用してください。
山括弧は、ユーザーに入力してもらいたい変数のプレースホルダーとして使用します（URLの場合は、プレースホルダーに波括弧を使用してください）。
例：
ユーザー指定のドメインをこの形式で入力してください: https://<user-specified domain>.cloudflare.com
{ "description": "<RULE_DESCRIPTION>"}数字が省略記号で区切られた山括弧は、ビットまたは単一名に関連付けられた値の範囲を表します - 例えば、AO <0...3>。
角括弧はオプションの項目を囲みます。
例：
この検索コマンドで始まるサブ検索を指定します: tag=dns query [search tag=malware].
波括弧は以下の状況で使用します：
コードサンプルや他の文字列リテラルの一部として、URL内のプレースホルダーなど。
例：
https://api.cloudflare.com/client/v4/organizations/{organization_identifier}/invites
>
記号は、ネストされたメニュー項目やダイアログボックスのオプションを通じて最終アクションに導きます。シーケンス Options > Settings > General は、Options メニューを引き下げ、Settings 項目を選択し、最後のダイアログボックスから General を選択することを指示します。> 記号に太字フォーマットを使用しないでください。
このアイコンはヒントを示し、アドバイザリー情報を警告します。
このアイコンはノートを示し、重要な情報を警告します。
このアイコンは情報を示し、重要な情報を警告します。
このアイコンは通知を示し、データ損失、信号の完全性の喪失、またはパフォーマンスの劣化を避けるための予防措置を講じるよう警告します。
このアイコンは注意を示し、怪我を避けるための予防措置を講じるようアドバイスします。
この色のテキストはリンクを示します。
太字は、クリック可能なアクションを指すときや、UI内のタイトルや名前を強調するために使用します。太字のテキストは、ソフトウェア内で選択またはクリックする必要がある項目、UI内の識別子、またはパラメータ名を示します。
プログラムには太字を使用しないでください。
ネストされたメニューでは、記号ではなく単語に太字を使用します。
例: Dashboard > This > That
イタリックは、顧客が選択できるオプションを指すときに使用します。ドロップダウンメニューのように。
トグルの状態を指すときにはイタリックを使用しないでください - 例えば、enabled/disabledはイタリックにしないでください。
`バックティックで囲まれたテキスト`
このフォントのテキストは、キーボードから入力する必要があるテキストや文字、コードのセクション、プログラミング例、構文例を示します。このフォントは、ドライブ、パス、ディレクトリ、プログラム、サブプログラム、デバイス、関数、操作、変数、ファイル、APIコマンド、および拡張子の固有名詞にも使用されます。
| 要素 | 例 |
|---|---|
| IPアドレスと範囲 | システム + DNSサーバーを 127.0.1.1 に変更します。 |
| ポート番号 | リクエストはHTTPサービス（ポート 80）を通じてリダイレクトされます。 |
| APIコマンド | エンドポイントはJSON形式の GET をサポートしています。 |
| ターミナルコマンド | コマンド wrangler login を実行します。 |
| 属性名と値 | type, name |
| クラス名 | button-primary |
| コマンドラインユーティリティ名 | wrangler, npm, node, cloudflared |
| データ型 | (string, number, int64) |
| 要素または属性の定義済み（定数）値 | <A_BINDING_NAME> |
| DNSレコードタイプ | ボットはデフォルトで AAAA レコードを探します。 |
| 列挙型（言語によって異なる）名 | type ContentTypeMapElem |
| 環境変数名 | <A_BINDING_NAME> |
| 要素名（山括弧を含む、XMLおよびHTML） | <div>, <form>, <input>, <code> |
| ファイル名、ファイル名拡張子（使用される場合）およびパス | wrangler.toml |
| フォルダとディレクトリ | ~/Downloads/Cloudflare_CA.crt |
| HTTP動詞 | POST, GET, HEAD, PUT, DELETE |
| HTTPステータスコード | 400, 200, 500ただし、 x プレースホルダーを使用したエラー範囲は等幅にしないでください: 5xx, 1xxxx。 |
| HTTPコンテンツタイプ値 | text/html, application/javascript; charset=utf-8 |
| HTTPヘッダー名 | Content-Length |
| コマンドやコードで入力または出力に使用されるURL | VERSION-dot-SERVICE-dot-PROJECT_ID.REGION_ID.r.appspot.com |
| IAMロール名 | roles/storage.admin |
| 言語キーワード | in, await |
| メソッドおよび関数名 | handleRequest |
| 名前空間エイリアス | numpy |
| プレースホルダー変数 | <YOUR_BUILD_DIR> |
| クエリパラメータ名と値 | /api/v4/{account_id} |
| テキスト入力 | "Hello Worker" |