Doxygen_Template_Comment.h

[詳解]

#pragma once
#include <stdexcept>
 
/**
 * @file ファイル名.h
 * @brief 簡単な説明
 * @author 書いた人
 * @date 日付（開始日？）
 * @since 1.0.0
 * 
 * 詳細は 
 * https://qiita.com/inabe49/items/23e615649e8539d857a8
 * https://cercopes-z.com/XMLDoc/index.html
 * https://cercopes-z.com/Doxygen/list-xmldoc-dxy.html
 * この辺参照
 */
 
/**
 * <summary>
 * 名前空間の説明
 * </summary>
 */
namespace SampleHoge
{
 
    /**
    * <summary>
    * 定数の概要
    * </summary>
    */
    const int SECONDS_IN_A_DAY = 86400;
 
    /// <summary>
    /// 変数の説明
    /// </summary>
    int hogeInt;
 
    /**
    * <summary>
    * 関数の説明
    * </summary>
    *
    * <param name="?int">関数の引数</param>
    * <returns>戻り値</returns>
    */
    bool HogeFunc(const int& _int) { return true; };
 
    /**
    * <summary>
    * クラス概要
    * </summary>
    *
    * <remarks>
    * クラス備考
    * </remarks>
    */
    class HogeClass
    {
 
        /**
        * <summary>
        * 例外を投げるサンプルの関数です。
        * </summary>
        *
        * <param name="age">年齢</param>
        * <exception cref="std::invalid_argument">年齢が負の値の場合に投げられる例外です。</exception>
        */
        void ExThrowFunc(int age) {
            if (age < 0) {
                throw std::invalid_argument("年齢は負の値ではありません");
            }
        }
    };
}