Doxygenのメモ

きっかけ

ちょっとだけDoxygenの勉強をしたのでメモっておこうかと。
(引用元はわすれました、ごめんなさい。)

メモ

# Doxygenの書き方

## ソース内ドキュメント
/*
 * 
 * 
 * 
 * 
 */

## 書き方
ファイルのはじめに書くもの
/**
 * @file ファイル名
 * @brief 一行要約を書き入れる
 * 
 * @par パラメータ(引数,returnする値)
 * @date 日付
 * @date 更新するたびにつける
 * @author 作者、筆者
 */

関数毎に書くもの(関数ドキュメント)
/**
 * コメント
 * @param 引数の説明
 * @param 引数の説明
 * @retunr returnする値
 */

ドキュメントに残るコメント
/** @var 変数の説明 */
/** @struct 構造体の説明 */
/** @class クラスの説明 */
/** @exception 例外の説明 */

ドキュメントに残らないコメント
/* */

非推奨コメントアウト
/*
こーど
*/
/*
こーど  
*/

推奨コメントアウト
//コード
コード