良いドキュメント・マニュアル・仕様書を書くスレ

良いドキュメント・マ ..

68:デフォルトの名無しさん
03/10/17 02:15
doxygen とかで（規約かなんかで）全ての関数インターフェースに
コメントをつけるとしたとき、仮引数名がその意味を完全に表していたときは
１．書かない
　→UNDOCUMENTEDの警告がいつも出てしまってほかの警告が霞んでしまう
２．繰り返す：@param instance インスタンス
　→かっこわるい
３．空にする：@param instance
　→まちがってる気がする
どれがいいんでしょうか？

次ページ

続きを表示

1を表示