問題タブ [documentation-generation]

私が現在所属しているソフトウェア グループは、最近、コードベースのドキュメント化を開始することを決定しました。彼らが採用している最初のアプローチは、組み込みのトリプル スラッシュ /// の文書化方法を使用することでした。

私たちが発見し始めた新しい問題は、doxygen を介してこれを実行した結果が、コードベースの非常に適切な表現であるということでした。タスクが正確に何をしているのかを尋ねます。

/// メソッドと doxygen を使用してコードを文書化する簡単な方法はありますか?特定の方法で実行すると、システム エンジニアリング バージョンの文書だけを含む文書を生成できます。メソッドやメンバー変数など、システム担当者を怖がらせる標準的なプログラマー向けドキュメントはありますか? 代替ソリューションの提案も大歓迎です。

これが私たちが達成しようとしていることについて少し混乱している場合は申し訳ありませんが、回答が得られたら調整できます. ありがとう.

私は、さまざまな言語で何年も使用してきたdoxygenの大ファンです。特に、画像を含め、Graphviz ドット ジェネレーターを実行して、インライン DOT コードまたは外部ファイルから任意のインライン ダイアグラムを作成できる wiki のような機能を高く評価しています。

RDocには、Graphviz を使用してクラス図を生成するためのダイアグラム サポートがありますが、任意の画像や図を含める方法がわかりません。また、酸素のような任意のページの構築もサポートしていないようです。

これらの Doxygen スタイルの機能を Ruby に提供するツールはありますか?

ツールのRuby Toolboxリストをざっと調べたところ、それらはすべてRDocのバリアントのようです。

現時点で私にとって最も可能性の高い解決策は、Yard を拡張することです。

ASP時代にさかのぼる非常に古いアプリケーションがあり、徐々にASP.NET + VB.NETコードベースにリファクタリングしています。

以下のタイプのファイルが多数含まれています。

aspx、asmx、ascx、vb、js (JavaScript)、html、vbs (VBScript)。

バックエンド データベースは、多数の sproc を備えた SQL Server 2005 です。

コード ファイル内のコメントから自動的に生成されるコード ドキュメントを作成したいと考えています。Doxygen はとても気に入りましたが、上記のテクノロジーをサポートしていないようです。できれば単一のツールまたはツールのグループを提案してください。

どうもありがとう。

アジット。

「XML ドキュメント ファイル」プロパティが有効になっている Visual Studio (C#) プロジェクトがあります。また、[警告をエラーとして扱う] が [すべて] に設定されています。

XML コメントがなく、追加されない特定のクラスが 1 つあります。XML ドキュメントとエラーとしての警告が有効になっているため、ビルドが失敗します。

XML ドキュメントに関して、この特定のクラスを無視する方法はありますか?

Sandcastle を使用して API ドキュメントを生成する予定です。Web サイトでこれを行う方法に関するガイドが見つかりませんでした。誰かが推奨するクイックスタートガイドはありますか?

私は Doxygen を組み込みの C ソースと共に使用しています。.c/.h ファイルのペアが与えられた場合、Doxygen コメントを関数プロトタイプ (.h ファイル) または関数定義 (.c ファイル) に配置しますか? それとも両方に複製しますか?

ある場所でドキュメントを作成し、他の場所ではドキュメントを作成しないと、Doxygen がコメントの欠落について警告するという問題が発生しています。これは予想どおりですか、それとも私のDoxygenが台無しですか?

他に誰が Scitools Understanding C++ のようなツールを作っていますか? どちらが優れていますか?

Ada、C、C++、および Fortran 用の最も完全な自動ドキュメンテーション ツールを探しています。ツールの移行作業を分析し、デッド コードを取り除き、重要な機能を特定するのに役立ちます。

ピート

マニュアルの生成に使用できるドキュメントの単一のソースを作成するために利用できるOSS （または無料）ツールは何ですか？具体的には、次の形式で：

• HTMLWebサイト
• PDFドキュメント
• 埋め込み（アプリケーション内、場合によってはHTML）¹
• テキスト（オプション）
• マニュアルページ（オプション）

追加要件：

• ツールはテクニカルライターに適しています（WYSIWYGである必要はありません）。
• XML/SGMLソース
• 高品質のPDF出力（TeXに匹敵）
• マルチプラットフォーム

拡張された要件¹

同じコマンドラインアプリケーションが2つの言語（CとJava）で記述されています。XMLを使用してコマンドラインオプション（一部はいずれかの言語に固有）を記述すると、XMLをJavaクラスまたは標準出力にヘルプを書き込むC関数に変換するのは簡単です。これにより、外部ファイルに依存することなく、ヘルプをバイナリに埋め込むことができます。

AsciiDocにはこの機能がないようです。別のオプションはありますか？