ゼロから学ぶMarkdown 第3回 ソースコードの表現

Markdown(マークダウン)はとてもシンプルな記述言語。文書を書くときの共通ルールみたいなもの。とにかくシンプルなのが特徴。Markdown対応のエディタを使えば文書が読みやすく表示されるので知っていると便利。今回は「ソースコードの表現方法」を学ぶ。

ソースコードの表現方法

ソースコードとして表現したい文章の前後にバッククォートを3つ記述することで、コードブロックとして表示できる。

サンプル記述:コードブロックの設定方法

 ``` 
  main(){
    printf("hello");
  }
 ```

実際にはこのように表現される。

main(){
  printf("hello");
}

ソースコードの表現方法の考察

エディタによっては下記のように表現される場合がある。

Sample Code

このときの記述方法は2つあった。 どちらもエディタ依存の可能性があるので各自確認頂きたい。

ケース1 バッククォートの後に改行なし

1つめはバッククォートの後に改行せずコードを記述するケース。 実際にはこのように表現される。

Sample Code

サンプル記述:コードブロックの設定方法 その2-1

 ```Sample Code```

ケース2 バッククォートの前にスペース挿入

2つめはバッククォートの前にスペースが挿入されているケース。 実際にはこのように表現される。

Sample Code

サンプル記述:コードブロックの設定方法 その2-2

 ```
 Sample Code
 ```

注意点

バッククォートの入力

バッククォートとは、この記号「 ` 」のことです。 自分のPCの場合、Shift + @ (Shiftを押しながら@ボタン)で入力できます。 シングルクォート「 ' 」とは異なるので注意して下さい。

おまけ

バッククォートの英語表記

英語では必ずしもbackquoteと言うとは限りません。 とくに海外ではbacktickとして使用されているケースも多くあります。 プログラミング言語や考え方にも依存するようです...

参考リンク

help.hatenablog.com help.github.com daringfireball.net