ドキュメント いくつかの課題

[NyaanNyaan]

書くべきこと(仮)

• 概要 (1~2 行でよい)
• テンプレート引数の説明
• 関数の説明・計算量
• 使用上の注意

必要かどうか微妙なラインのもの

• メンバ変数の説明 (内部の変数を触ることを想定したライブラリっぽそうなら必要)

他に何かあったら教えてください

ドキュメントに要らない部分をどうするか

• 関数の使い方を書かずにアルゴリズムの詳細な説明だけ書いていることがある
• リファレンスとして役に立たず、邪魔なだけ
• なんらかの対策を取るべきか？
  • 別サイトを作ってそちらにアルゴリズムの話を移す
  • そのまま残して、下部に関数の説明などを書く

doxygen の機能を使うか？

verification-helper のドキュメント生成には doxygen が使われているはずなので、たぶんいい感じにコメントをつけるといい感じのドキュメントが生成されそう (例：https://www.doxygen.nl/manual/docblocks.html#docexamples)

• すべてを書き直す必要が発生するので、厳しい

[NachiaVivias]

• verification-helper のドキュメント生成には doxygen が使われているはず

  本当ですか？使われていないように見えますが（こことか）。

[NyaanNyaan]

ほんとですね (勘違いしていた…) 情報ありがとうございます。

[NachiaVivias]

• (1) プログラム中の変数を数式に入れるときはどのように書けばよいですか？とくに複数文字のときはどうしますか？ 使われている例として、 `state = -1` 、 xとyが 、 $[a_l,a_r)$ 、 $Re[f]=fre,Im[f]=fim$(まれ) があります

[NyaanNyaan]

普通に $(変数名)$ で問題ないです、他の変数と文字がかぶって読みづらそうだったら $\mathrm{変数名}$ とかでお願いします