自分の場合、接頭辞にCBR_(Call By Reference)を付けていたりして注意を促したりしていますが、Doxygenで出力する場合 @param に方向属性を付けることであらわすことが可能です。
基本通りに記述するなら、
proc _hogehoge0( string $CBR[], string $outList[], string $list[] ) /**************************************************************************//** @protected @brief test procedure. @param[in,out] $CBR 説明※参照渡し @param[out] $outList 説明※参照渡し、初期化あり @param[in] $list リスト ******************************************************************************/ {
これが、こんな感じになります。
param コマンドを書くのが面倒な場合は、
proc _hogehoge1( string $CBR[], //!< [in,out] 説明※参照渡し string $outList[], //!< [out] 説明※参照渡し、初期化あり string $list[] ) //!< [in] リスト /**************************************************************************//** @protected @brief test procedure. ******************************************************************************/ {
こんな風に引数の後ろへ記述する事も可能。
上のとほぼ同じように出力されます。
ただし下のように混在させると
proc _hogehoge2( string $test, //!< test comment. string $CBR[], string $outList[], string $list[] ) /**************************************************************************//** @protected @brief test procedure. @param[in,out] $CBR 説明※参照渡し @param[out] $outList 説明※参照渡し、初期化あり @param[in] $list リスト ******************************************************************************/ {
引数が複数に分割されてしまうので注意。
参照渡しは結構説明が長くなりがちなので、@pre や @post なんかも合わせると良いかも。
0 件のコメント:
コメントを投稿