10
7

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

Markdown でコードの一部を強調したい

Posted at

コード中で太文字や文字色指定ができると書く側としては直感的なのですが、できないので、他の方法を考えてみます。
ここに書いた以外にも良い方法ないかな…?

1. コメントを添える

// ここに追加 # ここを書き換え みたいに書く。

  • メリット
    • 簡単
  • デメリット
    • コードが大きいとやっぱり分かりにくい
    • コメントがない言語だとつらい

2. 省略する

単純に、強調したい部分以外を省略する方法。
どこを省略したか分かるように「...」などを書く。
場所を分かりやすく説明を添える。

hoge.jsfuga() 関数の一番後ろに return piyo; を追加します。

hoge.js
// ... 略
    
    return piyo;
}

// ... 略

hoge.jsonfuga.piyo の値を "hogera" に書き換えます。

hoge.json
... 
  "fuga": {
    "piyo": "hogera"
  },
... 
  • メリット
    • 全体のコードが大きかったとしても分かりやすい
  • デメリット
    • JSON のようなコメントが書けない言語だと、シンタックスハイライトが上手くいかない可能性がある
    • 編集・追加・削除を表現しにくい

3. diff を使う

diff のシンタックスハイライトで見やすくする。
コードが小さい場合は略さずに diff にしてしまったほうが見やすいかも。
ここでは人力で + - を付け加えている (インデントは気にしない) 。

hoge.jsfuga() 関数の一番後ろに return piyo; を追加します。

hoge.js
// ... 略
    
+    return piyo;
}

// ... 略

hoge.jsonfuga.piyo の値を "hogera" に書き換えます。

hoge.json
... 略
  "fuga": {
-    "piyo": null
+    "piyo": "hogera"
  },
... 略
  • メリット
    • 編集・追加・削除を表現しやすい
  • デメリット
    • 言語ごとのシンタックスハイライトは使えない

参考「markdown で GitHub のような diff を表現する - Qiita

10
7
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
10
7

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?