コード中で太文字や文字色指定ができると書く側としては直感的なのですが、できないので、他の方法を考えてみます。
ここに書いた以外にも良い方法ないかな…?
1. コメントを添える
// ここに追加
や # ここを書き換え
みたいに書く。
- メリット
- 簡単
- デメリット
- コードが大きいとやっぱり分かりにくい
- コメントがない言語だとつらい
2. 省略する
単純に、強調したい部分以外を省略する方法。
どこを省略したか分かるように「...」などを書く。
場所を分かりやすく説明を添える。
hoge.js
のfuga()
関数の一番後ろにreturn piyo;
を追加します。hoge.js// ... 略 return piyo; } // ... 略
hoge.json
でfuga.piyo
の値を"hogera"
に書き換えます。hoge.json... 略 "fuga": { "piyo": "hogera" }, ... 略
- メリット
- 全体のコードが大きかったとしても分かりやすい
- デメリット
- JSON のようなコメントが書けない言語だと、シンタックスハイライトが上手くいかない可能性がある
- 編集・追加・削除を表現しにくい
3. diff を使う
diff のシンタックスハイライトで見やすくする。
コードが小さい場合は略さずに diff にしてしまったほうが見やすいかも。
ここでは人力で +
-
を付け加えている (インデントは気にしない) 。
hoge.js
のfuga()
関数の一番後ろにreturn piyo;
を追加します。hoge.js// ... 略 + return piyo; } // ... 略
hoge.json
でfuga.piyo
の値を"hogera"
に書き換えます。hoge.json... 略 "fuga": { - "piyo": null + "piyo": "hogera" }, ... 略
- メリット
- 編集・追加・削除を表現しやすい
- デメリット
- 言語ごとのシンタックスハイライトは使えない