Doxygen6(構造体とenumのコメント) (original) (raw)

・目次

1.目的
2.コメントの付け方
3.Doxygenでドキュメント作成確認(コメント)
4.Doxygenでドキュメント作成確認(実際に使用して作成した場合)
関連記事

1.目的

・Javadocで使用されるコメントの書き方について記載する。

・コメントを記載した場合、Doxygenでどのように出力されるのか確認する。

参考：Doxygen(コメント)

2.コメントの付け方

・JAVADOCには、それぞれコメントの種類によって、タグが用意されている。

・ここでは、下記3.Doxygenでドキュメント作成確認にて、それぞれのタグと、その意味、その結果としてDoxygenで作成した場合の出力結果を示している。

・Doxygenの設定に関しては下記ブログを参照

→Doxygen4(DoxygenでGraphwizを使用) - Project_OKI’s diary

3.Doxygenでドキュメント作成確認(コメント)

#include <stdio.h> #include "main.h"

int main() { printf("test"); return 0; }

typedef enum{ en1, en2, en3, }ENU;

typedef enum{ t_en1, t_en2, }TENU;

typedef enum{
　　　　t2_en1,
　　　　t2_en2,
}TENU2;

typedef struct{ ENU enu1; int st1; int st2; }ST;

typedef struct{ int t_st1; }T_ST;

typedef struct{ int m_st1; }M_ST;

---JAVADOC出力結果---

・構造体がある場合、Data Structuresタブが生成される。

・Data Structuresタブには構造体のまとめが書かれる。

・///又は、/** */で囲むことにより、@タグの種類によって、設定できる。

・構造体をクリック時

・M_ST構造体をクリック時

・STクリック時

・T_STクリック時

上記のように構造体に関する情報がまとめられる。

・列挙型のまとめ

・main.h又は、ENUクリック時

4.Doxygenでドキュメント作成確認(実際に使用して作成した場合)

#include <stdio.h> #include "main.h"

int CalcDouble(int setnum){ int set = setnum * 2; return(set * 2); }

#define SETNUM1 10 #define SETNUM2 20

int ModeSel(T_ModeData g_ModeData){ int set = 0; switch(g_ModeData.mode){
case MODE1:
set = CalcDouble(SETNUM1); break; case MODE2:
set = CalcDouble(SETNUM2); break; default: break;
}
return (set); }

int main() {

T_ModeData g_ModeData = {
    MODE1,		              
    {0,0,0},		      
};


for(g_ModeData.mode=MODE1;g_ModeData.mode<=MODE3;g_ModeData.mode++){
    g_ModeData.modenum[g_ModeData.mode] = ModeSel(g_ModeData); 
    printf("modenum = %d\n",g_ModeData.modenum[g_ModeData.mode]);
}
return 0;

}

typedef enum{ MODE1, MODE2, MODE3, }MODE;

typedef enum{ TMODE1, TMODE2, }TMODE;

typedef struct{ MODE mode;
int modenum[3]; }T_ModeData;

実行結果

・https://paiza.io/projects/UHcKLEDZyOcgSOxgv08j1w

---JAVADOC出力結果---

・main.cファイル