先頭へ戻る

ドキュメント | Programming Place Plus 用語集

Programming Place Plus トップページ -- 用語集

先頭へ戻る

名称

解説

ドキュメント(文書)を作成することです。

ドキュメントの具体例として、仕様書、リファレンスAPI の解説など)、マニュアルリリースノートといったものがあります。これらを必ずしも手動で作成する必要はなく、ツールを使って一部や全体を自動生成することもあります(データの集まりからグラフを自動生成したり、ソースコードからリファレンスを自動生成したり)。

ソースコードからのドキュメント生成については、ドキュメントに抜き出す内容をソースコード上に特別な記法のコメント(ドキュメンテーションコメントなどと呼ばれる)を使って記述します。ドキュメントは Doxygen などの専用ツールを使って生成できるほか、プログラミング言語によっては、こういった特別なコメントの仕様が定められており、標準で提供されるツールによってドキュメントを生成できるものもあります(Java の Javadoc など)。


参考リンク

更新履歴


用語集のトップページへ

Programming Place Plus のトップページへ



はてなブックマーク に保存 Pocket に保存 Facebook でシェア
Twitter でツイート Twitter をフォロー LINE で送る
rss1.0 取得ボタン RSS 管理者情報 プライバシーポリシー