Eclipse - ドキュメント自動化 - キーワード

クラウディア 
1. 概要
2. 一覧

1. 概要

 キーワードという言い方は、「Doxygen」の用語としては、正しくないのかもしれません。  というのも「Doxygen - 特殊コマンド」では、「特殊コマンド」と表記してあるからです。  しかし、どうも「特殊コマンド」という言い方にはなじめないので、ここでは、「キーワード」という表記を使用します。  つまり、ソースのコメント欄に以下に述べる「キーワード」を適切な書き方で、書くことにより、うまいことドキュメント化されるからです。  これらは、例えば、後述する「Pyrhon」であれば

##
# @キーワード キーワードに対する本文
 とコメントを記述することによって、ドキュメント化されます。

2. 一覧

 例によって、わたしが実際に使ってみて、どうドキュメント化されるか確かめたものの一覧です。  全部を見るには、冒頭の参考サイトを読んでください。
キーワードと続く文字  表題   意味   備考 
author 作者 著者 作者
brief 説明 簡単な説明
details 説明 詳細な説明
param 引数 説明 引数 引数と説明
version 番号 バージョン バージョン番号
warning 警告文 警告 警告文 赤いバーとともに出力
note メモ 覚え書き メモ 茶色いバーとともに出力