c# - 開発者マニュアル

Question

私のチームと私は、ソフトウェア開発プロジェクトの最終段階にあります。Visual Studioを使用して、プロジェクトをコンパイルし、C＃でコーディングしています。ユーザーマニュアルを作成する必要があります。アプリケーションとコードのコメントからユーザーマニュアルを生成する方法はありますか？

Answer 1

コードに適切にコメントを付けていれば、ドキュメントの生成に使用できるサードパーティ ツールが多数あります。

次のリストはすべてを網羅しているわけではありません。

• 砂のお城
• NDoc
• ドク・オ・マティック
• VSdocman
• ドキシジェン
• ...

エンドユーザーが開発者であり、何らかの API を作成していることを願っています。この種のドキュメント生成ツールは、通常、社内での使用、または使用できる API を作成した社外の開発者にのみ適しています。

Answer 2

ターゲットオーディエンスが他の開発者である場合は、このSO投稿に記載されているようなことを行うことができますが、開発者ではないエンドユーザーの場合、コード内のコメントがすべてになる可能性は低くなります。彼らにとって有用であり、もし彼らがそうであるなら...それなら彼らはおそらく開発者にとってそれほど有用ではないでしょう。