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