問題タブ [documentation-generation]

Ada ソース コードからヘッダーの依存関係を追跡/グラフ化するツールはありますか?

私は最近、ドキュメントの比較に「WinMerge」というアプリケーションを使用していますが、私のチームのスクリプト ファイル (監査目的) の要件の 1 つは、スクリプトのリビジョンをリリースするときに、変更点を赤色 (RTF 形式) で強調表示することです。 Lotus Notes 経由だと思います)そのために、変更を自動的に強調表示できるソフトウェアはありますか?それとも、相違点のリストを取得し、すべての変更を手動で強調表示するのに最適なソフトウェアはありますか?

hannaテンプレートを使用してRuby ドキュメントを生成したいと考えています。

どうやってするか？または、入手できる場合はどこでダウンロードできますか?

使用する

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

メソッドが欠落しているドキュメントを教えてくれます。Cで書かれたメソッドを生成しないようです。

配布している Flash (AS3) コンポーネント ライブラリがあり、リリースごとに完全に文書化されていることを確認したいと考えています。Microsoft の C# 用の自動ドキュメント生成で私が本当に気に入った点の 1 つは、ドキュメントのタグ付け形式でドキュメント化されていないパブリック メンバーに対して、(コンパイルのたびに) コンパイラに警告を生成させることができることです。

これは、すべてのコードを完全に文書化したことを確認するのに非常に役立ちました。

ASDoc で同様の機能を有効にする方法はありますか?

アドバイスやヒントをありがとうございます。これが Eclipse / Flex Builder 内から機能することを望んでいますが、Ant を使用しても問題ありません。

このような要件を満たすヘルプ/ドキュメント生成ツールを探しています。

• C# コンパイラによって生成された xmldoc コメントをサポートするか、(さらに良いことに) サンドキャッスルを直接サポートする必要があります。
• MS Word ドキュメントのインポートをサポートする必要があります。
• 概念ドキュメントからソース コードから生成された参照ドキュメントへのリンクの作成をサポートする必要があります。
• MS Word での概念的なドキュメント オーサリングがサポートされているとよいのですが

詳細。私のプロジェクトは、.NET のフレームワーク/ライブラリです。合計で 50 以上の C# プロジェクトを含む複数の VS ソリューションがあります。まず、プロジェクトのソース コードからヘルプ (将来的には chm & help2 & help3) を生成したいと考えています。そのドキュメントを「参照ドキュメント」と呼びます。サンドキャッスル (特にSCFBを使用した場合)）これは非常に良い方法で行うことができます。しかし (非常に一般的な状況だと思います)、フレームワーク/ライブラリに関する追加のドキュメントがあります。そのドキュメントは MS Word ファイル (5 ～ 10 ファイル) です。そのドキュメントを「概念ドキュメント」と呼びます。概念ドキュメントと参照ドキュメント (MSDN など) を備えた堅固なヘルプ システムを作成したいと考えています。また、ヘルプの概念部分には、フレームワーク/ライブラリからのすべての .NET タイプ名のヘルプの参照部分を参照するリンク (URL) が含まれている必要があります。(明らかに、どのヘルプ システムも最終的には単なる HTML です)。

問題は、これらのリンクを作成する方法です。MS Word ファイルは、C# xmldoc について何も知りません。Sandcastle は Word ファイルをサポートしていません。そのため、ヘルプ オーサリング ツール (HAT) を使用する必要があります。今のところ、適切なツールが見つかりません。そして、私はどんな助けにもとても感謝しています!

すべてのツールの障害は、リンクの自動作成です。生成中にリンクが自動的に作成されるようにします (ビルド サーバーで実行できます)。なぜ自動的に？型の名前を簡単に変更できるためです。たとえば。概念ドキュメントにテキストがあります:「リクエスト処理コンテキストにアクセスするには、XOperationContext タイプの静的プロパティ Current を使用します」。ここで XOperationContext は型名です。結果ヘルプシステムの XOperationContext クラスの仕様へのリンク (URL) を、さほど手間をかけずにできるようにしてほしいです。Word（おそらくHATのプラグインがインストールされている）またはHATのエディターで、「可能であればこの単語をリンクする」のようなものとしてマークしたいと思います。生成中に、そのような名前の型名があれば、そのような単語はそれぞれリンクになります。

私はこれらのツールについて知っています：

• Toolsfactory Doc-o-Matic (現在使用中)
• Innovasys DocumentX と HelpStudio
• ComponentOne Doc-to-Help

Doc-o-Matic サポート リンクの自動作成。本当に自動的に。PascalCase の各単語のリンクを作成しようとします - 見事です。ただし、MS Word には対応していません。Innovasys および ComponentOne のソフトウェアは、リンクの自動作成をサポートしていません。Innovasys のソフトウェアは MS Word をサポートしていません (これについては 100% 確信が持てません)。

Innovasys と ComponentOne のフォーラムで質問してみました。これまでのところ運がありません。私のような Innovasys のソフト サポート シナリオ: 別のツール (HelpStudio) で概念的なドキュメントを作成し、別のツール (DocumentX) でソース コードからヘルプを生成する。ただし、リンクを自動的に作成して MS Word ファイルをインポートする機能はありません。

ですから、その一般的なタスクの有効期限を共有してください (一般的なはずです)。

ps 英語の文法の観点から自分の考えを正しく説明できていない場合はお知らせください。もう一度試します。

Sphinxは、Python 用の新しいドキュメント ツールです。とても素敵に見えます。私が疑問に思っているのは：

• これは C++ プロジェクトの文書化にどの程度適していますか?
• 既存のドキュメント (doxygen など) を Sphinx 形式に変換するツールはありますか?
• Sphinx を使用する C++ プロジェクトのオンライン/ダウンロード可能な例はありますか?
• Sphinx を使用したことがある人からのヒントはありますか?

最近、CruiseControl の構成を調べています (私は完全な CC 初心者です)。これまでのところ、ビルド プロセスによって生成されたさまざまな XML レポート (mbunit.xml、ncover.xml、fxcop.xml など) をxml への参照を ccnet.config の次の部分に追加して、ダッシュボードを作成します。

xsl ファイルを追加して xml を表示可能な html に変換し、xsl を参照するレポート ビルド プラグインを dashboard.config に追加します。

私の質問は、純粋な HTML であるレポート (JGregory の Docu によって生成されたコード ドキュメントと jpboodhoo の Bdddoc によって生成されたテスト仕様) がある場合、これらを同様の方法でダッシュボードに表示する方法はありますか? 私はこれを理解することはできません。HTML ページに直接 ExternalLink を追加することも考えましたが、これはユーザーが通常アクセスできない保護された領域にあります。誰でもアイデアはありますか？

Sphinx は、いくつかの出力形式をサポートしています。

• 複数の HTML ファイル (htmlまたはを使用dirhtml)
• .pdf作成や作成に役立つラテックス.ps
• 文章

代わりに、Microsoft Word ファイルで出力を取得するにはどうすればよいですか?

別のドキュメント ジェネレーターを使用して、単一の html 出力ファイルを生成し、Word アプリケーションを使用して Microsoft Word 形式に変換することができました。

残念ながら、Word または HTML の単一ページ形式を生成する方法がわかりません。