LoginSignup
2
2

More than 3 years have passed since last update.

Markdown記法を知って、愛される質問者になる方法 - 初学者が質問サイトで気をつけたいことと対策-

Last updated at Posted at 2020-08-24

はじめに

私自身プログラミング初学者ですが
プログラミング質問・回答サイトでと、ひたすら回答するという経験をもとに記事を書いています

プログラミングを学ぶと必ず自己解決できない場面があります
そういった場面で他者に質問して助けを求めることはとても有効だとも思います

ただ、質問する際にも流儀があって、
それは初学者が気づきにくいことであり、知っていると一目置かれるものであると感じています
初学者かつ、回答者という両視点を経験したからこそ、
以下のことを知って実践していただき、愛される質問者を目指してください

もし、お役に立てたらLGTMいただけましたら嬉しく思います

質問サイトでやってはいけないこと

コードをスクリーンショットで貼るのをやめましょう

  • 小さい文字は読めません

  • コピーできないため、検証や回答に不便です

  • 回答する側にも、回答が得られないあなたにも不都合です

外部リンクをベタ書きするのはやめましょう

  • URLをベタ書きすると、読み手はコピー、貼り付けの作業が必要で面倒です

相手への優しさや感謝が、あなたの問題解決につながります

では、具体的にどうすればよいのか以下に書きますので上から3つまでは必ずおぼえてください

Markdownという書式を覚えましょう

必須の3書式
これを覚えられなければエンジニアを目指すことを諦めてください

1 コードブロック

書式

複数行のコードを貼るときは(バッククォート)3つでコードを囲います
macユーザーなら (Shift + @)

```
コード
```

サンプル

```html
<!DOCTYPE html>
<title>Title</title>
<style>body {width: 500px;}</style>
<script type="application/javascript">
function $init() {return true;}
</script>
<body>
<p checked class="title" id='title'>Title


<!-- here goes the rest of the page -->
</body>
```
<!DOCTYPE html>
<title>Title</title>
<style>body {width: 500px;}</style>
<script type="application/javascript">
  function $init() {return true;}
</script>
<body>
  <p checked class="title" id='title'>Title</p>
  <!-- here goes the rest of the page -->
</body>

Tips

```に続けて言語名を書くと、コードがハイライトされて読みやすいです(シンタックスハイライト)

2 コード

書式

改行やインデントが不要なコードは`(バッククォート)1つで囲います

`code`

サンプル

`hogehoge`

hogehoge

3 外部リンクURL

書式

リンクのタイトルを[]で囲い、URLを()で囲います

[リンクタイトル](リンクURL)

サンプル

[naokit-dev - Qiita](https://qiita.com/naokit-dev\)

naokit-dev - Qiita

その他

知っていると便利です

見出し

# (# + space)に続けて書くことで見出しになります
#の数が見出しの強さを反映します

# h1 hello world

## h2 hello world

### h3 hello world

#### h4 hello world

h1 hello world

h2 hello world

h3 hello world

h4 hello world

リスト

- (- + space)でリストを表現できます

- hoge
- fuga
- hogefuga

  • hoge
  • huga
  • hogehuga

宣伝

プログラミング初学者がコードをスクショで共有しているのを見て
なにかいい方法はないかと思いアプリを開発してみました

Markdown書式の練習用や、実際の問題解決に役立てていただけると嬉しいです

mdClip <オンラインmarkdownエディタ>

  • オンラインMarkdownエディタ
  • 生成したMarkdownをURLで共有可能(URLをTwitterに共有可能)
  • ユーザー登録不要ですぐ使える
2
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
2