コードの埋め込み方

WSOFTDocsで公開されている記事にコードを埋め込むには、次の3つの方法があります。

インライン形式のコード¶

インライン形式のコードで表すべき要素は、プログラミング言語のキーワード、クラス名、関数名などです。どれをこの形式で表すべきかは、明確に決まっていませんが、判断に迷う場合はテキストの書式設定に関する指針を参照してください。

インライン形式でコードを表すには、バッククオート（`）でテキストを囲みます。 次に例を示します。

プレースホルダー¶

提供するコードのうち、ユーザーが一部を各々に応じて置換できるようにするには、山かっこで囲んだプレースホルダーを使用しましょう。次に例を示します。

echo <好きなテキスト>

波かっこは、プレースホルダーとして使用しないでください。波かっこは、文字列補間やテンプレート構文など、一部のプログラミング言語で意味を持つ表記となり、間違いのもとになります。

リンク¶

場合によっては、実際のコードへを埋め込む代わりにリンクを設置することは、コードを埋め込むより適切である場合があります。

次に例を示します。

この関数は、[env_newline](../products/alice/api/alice/environment/env_newline.md)の戻り値を使用します。

2回目以降は、`env_newline`のようにコード形式で十分でしょう。

この関数は、env_newlineの戻り値を使用します。

2回目以降は、env_newlineのようにコード形式での表記で十分でしょう。

スクリーンショット¶

ドキュメント内にコードを埋め込む方法として、スクリーンショットを使用しないでください。 スクリーンショットは、他の方法と比較して、以下のような問題点があります。

• コードをコピーできない
• 検索エンジンに認識されない
• 読み上げ機能などユーザー補助機能が使用できない

コードブロック¶

記事ファイル内のテキストがプログラムコードであることを表すには、バッククォート3つを使用してフェンスを作成します。

コードブロック内で使用されているプログラミング言語を指定するには、開始時のバッククォートの後に言語名を記述します。

コードブロックのタイトルは必ずつけてください。タイトルはtitle=の後で指定できます。

マークダウン表記

```json title="Jsonの例"
{
  "name": "John Doe",
  "age": 30,
  "city": "New York",
  "isStudent": false,
  "grades": [85, 90, 78],
  "address": {
    "street": "123 Main St",
    "zipCode": "10001"
  }
}

表示

{
  "name": "John Doe",
  "age": 30,
  "city": "New York",
  "isStudent": false,
  "grades": [85, 90, 78],
  "address": {
    "street": "123 Main St",
    "zipCode": "10001"
  }
}

使用できる言語と言語名の詳細については、「Language names and aliases」を参照してください。