良いドキュメント・マニュアル・仕様書を書くスレat TECH
良いドキュメント・マニュアル・仕様書を書くスレ - 暇つぶし2ch436:デフォルトの名無しさん
07/08/12 01:05:32
>>430
doxygen ではよくこの書き方が紹介されているが、個人的にあまりおすすめしない。
/*!
@brief メソッドの説明
@param p 引数の説明
@return 戻り値の説明
*/
・複数行コメントは一括コメントアウトの邪魔になるから
・実コードで引数が変更になると Doxygen の内容も変更しなくちゃいけなくなるから
 (つまりコードと Doxygen の2重管理になる)


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