良いドキュメント・マニュアル・仕様書を書くスレat TECH
良いドキュメント・マニュアル・仕様書を書くスレ - 暇つぶし2ch68:デフォルトの名無しさん
03/10/17 02:15
doxygen とかで(規約かなんかで)全ての関数インターフェースに
コメントをつけるとしたとき、仮引数名がその意味を完全に表していたときは
1.書かない
 →UNDOCUMENTEDの警告がいつも出てしまってほかの警告が霞んでしまう
2.繰り返す:@param instance インスタンス
 →かっこわるい
3.空にする:@param instance
 →まちがってる気がする
どれがいいんでしょうか?


次ページ
続きを表示
1を表示
最新レス表示
レスジャンプ
類似スレ一覧
スレッドの検索
話題のニュース
おまかせリスト
オプション
しおりを挟む
スレッドに書込
スレッドの一覧
暇つぶし2ch