質問投稿するときMarkdownは使って欲しい!
某QAサイトで質問を覗いてみるとMarkdownを使用していない投稿がよく見受けられます。その様な質問は大抵回答が得られなかったり回答者にも反応してもらえる確率は比較的低いかと思います。そこでMarkdownを使う必要性と簡単な利用方法を紹介していきます。
今回紹介しているMarkdown記法は質問する際に最低限必要な一部の記法に過ぎません。もっと知りたい方はMarkdown記法 チートシートなどを参照してください。
何故Markdownが必要なの?
では何故Markdownで書く必要があるのでしょうか?
結論からいうとMarkdown記法を使用することで可読性が上がったり、回答者がそのコードを用いて簡単に環境を再現できるからです。よって結果的に回答や反応がされやすくなるという訳です。
MarkDownを使用しない質問
MarkDownを使用した質問
<?php
$hoge = TRUE;
if ($hoge === true) {
echo "BINGO!!";
}
?>
実際にMarkdownを使用していない質問と使用した質問を見比べてみましたが実はこれ全く同じコードなのです。Markdownを使用していない質問ではインデントが解釈されていなかったり逆に使用した質問ではシンタックスハイライトにより原因が全角の)
であるであるということが直感的に分かります。
Markdownって何?
日本語Markdownユーザー会のサイトでは以下の様に説明されていました。
Markdown(マークダウン)は、文章の書き方です。デジタル文書を活用する方法として考案されました。特徴は、
- 手軽に文章構造を明示できること
- 簡単で、覚えやすいこと
- 読み書きに特別なアプリを必要としないこと
- それでいて、対応アプリを使えば快適に読み書きできること
などです。Markdownはジョン・グルーバー(John Gruber)によって2004年に開発され、最初は Daring Fireball: Markdown で公開されました。その後、多くの開発者の手を経ながら発展してきました。
簡単に言えば文章を簡単にマークアップし、文章の構造を直感的に理解できる様な記法のことです。
質問する際に最低限使う記法
コードを提示する際
コードを提示する際はバッククオート
3つでコードを囲むことでシンタックスハイライトされます。
また構文にもある様に上のバッククオートにはその言語名を記載します。
構文:
```(言語名)
コード
```
ex:
```PHP
echo 'Hello Markdown!';
```
preview:
echo 'Hello Markdown!';
リンクを貼る際
サイトやドキュメントのリンクを貼る際は以下の構文の様にリンク先の説明を[]
で囲みそのURLは()
で囲む必要があります。
構文:
[リンク先の説明](URL)
ex:
[Google](https://www.google.com/)
preview:
見出しを書く際
#
を1から6個記述することで見出しを表現できます。
構文:
# 見出し
ex:
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
preview:
見出し1
見出し2
見出し3
見出し4
見出し5
見出し6
画像を埋め込む際
サイトやドキュメントのリンクを貼る際は以下の構文の様にリンク先の説明を[]
で囲みそのURLは()
で囲む必要があります。
構文:
![画像の説明](画像のURL)
ex:
![350 * 150の画像](https://via.placeholder.com/350x150)