プログラムを書くとき、コメントで別の部分や関数を参照する必要がある場合があります。たとえば、以下のコードでは、2 つのアンカー "workaround1" と "workaround2" (別のファイル内) をコメントに設定し、関連するコメントへの参照を使用して ABC 関数についてメモすることができます。
// this part does <<workaround1>>
a = 1;
a++;
...
// [[workaround1]] and [[file:c.java::workaround2][2]] can be removed once ABC is fixed
c = ABC();
2 つの質問があります。
- そのような参照のベストプラクティスはありますか? プロのプログラマーはどのように対処しますか?
- このようなメモを含むソース コード コメントのナビゲーションを容易にする emacs 用のパッケージはありますか? 私は、(できれば任意の) 言語モードの上で動作できる org-mode 拡張について考えていました。
Redmine に関する同様の質問について認識しています: Redmineでプロジェクト間のソース参照を作成できますか?