女性向けエンジニアスクール
3秒でわかる
文章の途中に短いコードを埋め込む書き方。Markdown ではバッククォート 1 つで囲み、変数名やコマンドを地の文とはっきり区別するために使います。
もう少し詳しく
どういうものか
インラインコードは、段落の中に混ぜて書く短いコード断片です。Markdown ではバッククォート 1 つで囲むと表現でき、等幅フォントと薄い背景色で表示されます。HTML に変換されると code 要素になります。
囲めるのは変数名、関数名、ファイル名、コマンド、キー名、設定値、HTML のタグ名など、コードの世界から持ってきた文字列全般です。複数行にまたがる場合はインラインコードではなくコードブロックを使います。
なぜ必要か
地の文と識別子の境目をはっきりさせるためです。
たとえば「userName を空にする」と書くと、userName が変数名なのか説明語なのか読み手には判断できません。userName と囲めば、それがコード中の名前だと一目で伝わります。日本語の文章では単語の切れ目が空白で示されないぶん、この効果は英語より大きく効きます。
もう一つ実利があります。囲んだ範囲では記法が解釈されなくなるので、* や _ を含む文字列が意図せず強調に化けるのを防げます。
具体例
`app.js` を開き、`const` を `let` に書き換えてください。
実行は `npm run dev` です。ポートは `5173` になります。
中にバッククォートを含めたいときは、外側を 2 つにして
両端に空白を入れます -> `` `code` ``
コードが複数行になるならこちら。
```js
const total = items.reduce((sum, item) => sum + item.price, 0);```
つまずきやすいところ
囲んだ中では他の記法が効かなくなる点を見落としがちです。リンクを張ろうとして URL ごとインラインコードにすると、クリックできないただの文字列になります。太字や斜体も同じく無効です。
装飾のつもりで使いすぎるのも読みにくさにつながります。「ここは
重要です」のように日本語まで囲むと、コードだという意味が薄れ、本当のコードが目立たなくなります。囲むのは、そのまま入力したりコピーしたりできる文字列に限るのが目安です。なお、囲んだ内側の空白は 1 つに詰められて表示されます。空白の数そのものを見せたい場合はコードブロックを使います。
似た用語との違い
書き方 記号 用途 インラインコード バッククォート 1 つ 文の途中の短い断片 コードブロック バッククォート 3 つ 複数行のコード。言語名を付けて色分けできる 引用 行頭の >` 他所から引いてきた文章
見た目が似ているため混同されますが、コードブロックは前後で段落が切れる独立した塊、インラインコードは文の一部という違いがあります。
覚え方
1 つで囲めば行の中、3 つで囲めば行のかたまり。バッククォートの本数と、囲める範囲の大きさが対応しています。
