タグ

コメントとprogrammingに関するsoramame-papa0615のブックマーク (1)

  • XMLドキュメントコメントを用いたドキュメントの作成 - smdn.jp

    クラスライブラリなどを提供する場合、同時に使い方や詳細な仕様をまとめたドキュメント(APIリファレンス)も提供する場合があります。 これらを個別に作成・メンテナンスすることも出来ますが、バージョンアップを重ねる度に実装とドキュメントの内容の同期を取るのは手間のかかる作業です。 これを解決する一つの方法として、ソースコード中にコメントとして直接APIのリファレンスを記述することで、実装とドキュメントの同期をしやすくするというやり方があります。 この場合、コメントからドキュメントを作成する方法が問題となってきます。 Doxygenなどこの様な機能を提供する専用のツールは存在しますが、C#およびVBコンパイラではこの様な要求を満たすXMLドキュメントコメントという機能がコンパイラの機能として用意されています。 XMLドキュメントコメントは、Javadocと同様の機能を提供するものです。 ここでは

    XMLドキュメントコメントを用いたドキュメントの作成 - smdn.jp
  • 1