問題タブ [documentation-generation]

新しい従業員のレガシーデータベーススキーマを文書化する必要がありますが、設計文書がないため、既存のスキーマから生成したいと思います。テーブルはMyISAMであるため、外部キーの関係は適切なグラフを生成しません。重要な表、その列、タイプ、および注釈を示すドキュメントを作成することに興味があります。

データベーススキーマのメタデータから優れたドキュメント（PDF、DOC、HTML、RTFなど）を作成するために利用できるツールはありますか？または、これを自分でエクスポートするユーティリティを作成する方がよいでしょうか（XMLにダンプしてから、XSLTを使用して変換することを考えていました）。スキーマはMySQL5で実行されています。

今週末、私はWindows 7（素晴らしい！）をインストールしました。そこで、 ProblemStepsRecorderと呼ばれるこの素晴らしいツールを見つけました。どうやら、ベータバグ報告ツールに付属しているツールです。

私は現在、他の開発者のためにいくつかのアプリケーションの使用法を文書化しようとしています。（この場合、SQLプロファイラーでShowplan XML統計を取得する方法と、Database Engine Tuning Advisorの基本的な使用法）。そして、私はその問題ステップレコーダーのようなツールがこれに最適だと思っていました！唯一の問題は、それがWindows 7（？）にのみ存在し、出力がmhtファイルであり、一般的なバグ問題のテキストなども含まれていることです。

とにかく、このツールがより一般的なバージョンで利用可能かどうか誰かが知っていますか？または、Vista（および可能であれば他のWindowsバージョン）でも同じようなことを行う無料でスムーズな代替手段がある場合はどうなりますか？

以前は C と C++ に Doxygen を使用していましたが、現在は Fortran プロジェクトに取り掛かっているので、アーキテクチャをすべて包括的に見てみたいと思います。

過去に、アーキテクチャのドキュメントが存在しない場合にリバース エンジニアリング ツールが役立つことを発見しました。

では、Fortran コードをリバース エンジニアリングするツールはありますか?

Doxygen を使用しようとしましたが、運がありませんでした。私は 2 つの異なるプロジェクトに取り組んでいます。1 つは Fortran 90 で、Fortran 77 にあると思います。

洞察とフィードバックをありがとう。

憶測に過ぎないとは思いますが、詳しい方からのコメントをお待ちしております。MS Word COM アドイン、OO ブリッジ、またはカスタム実装のようなものです。

私が知りたい理由は、基本的なオンライン ドキュメント編集 (この時点では非常に基本的で、基本的にはリッチ テキストのみ) を php Web アプリに提供したいからです。マークアップを html 形式で保存し、ユーザーの利便性のために rtf/doc などに変換すると思います。

私は小さなおもちゃのプロジェクトに取り組んでおり、そのプロジェクトはどんどんリリースされています。これまで、ドキュメントは、プロジェクト用に設定した wordpress ブログの一連のページに過ぎませんでした。ただし、時間が経つにつれて新しいリリースが出てくるので、最新のリリースに合わせてオンライン ドキュメントを更新する必要があります。

残念ながら、そうすると、ドキュメント ページが最新バージョンに更新されるため、以前のリリースのドキュメントは「消えて」しまいます。そのため、ドキュメントをリリース パッケージに含め、最新のドキュメントをオンラインで利用できるようにしておくことにしました。ウェブページも。

些細なアイデアは、WordPress ページから現在のドキュメントを wget し、それらを svn に保存して、したがってリリース パッケージに保存し、新しいリリースごとに手順を繰り返すことです。残念ながら、取得した HTML を手動でハックしてリンクを修正する必要があります (または、Wordpress をハックして BASE を使用し、HTML コードを簡単に再配置できるようにする必要がありますが、これはやりたくないことです)。

同時に持つ要件をどのように処理すればよいですか:

1. ダウンロード可能なパッケージに含まれる適切なバージョンのユーザーが閲覧可能なドキュメント
2. 最新のドキュメントはオンラインで入手できます (そして、私の Web テーマで適切にスタイル設定されています)
3. svn と実際のオンライン コンテンツとの間で同期を維持します (ワードプレス、またはワードプレスのセットアップにうまく適合するその他のもの)。
4. 使いやすい

ありがとう

編集：より多くの答えを引き出すことができるかどうかを確認するために賞金を開始しました. これはかなり重要な問題だと思いますので、今後の読者のために複数のヒントや意見をいただければ幸いです。

開発者が使用しているプロジェクトドキュメント用のApacheForrest製品の現在のアクティブな代替ツールは他にもあるのでしょうか。2007年以降、v0.8リリースでスタックしているようです。

私は、maven sitevia Antを使用して、プロジェクトのさまざまなjavadoc、pmd、およびfindbugレポートを含むHTMLレポートを生成することを考えています。他の開発者がそこで何を使用しているのか疑問に思っています。

ソース コードの一部を XML ドキュメントに追加したいと思います。次のように、ソース コードをいくつかの <code> 要素にコピー & ペーストできます。

これを維持するのは苦痛でしょう。C# の XML ドキュメントにソース コードを追加する可能性は他にありますか?

Sandcastle で XML ドキュメントを処理しており、そこからテクニカル ヘルプ ファイル (*.chm) を作成したいと考えています。そのヘルプ ファイルに、一部または完全なメソッド本体を追加したいと考えています。

編集: slide_rule からのコメントをありがとう。より現実的であまり自明ではない例を追加しました。

次のようなメソッドがあるとします。

料金の計算方法に関する情報をテクニカル ヘルプ ファイルに追加できると便利です。

最も明白な解決策は、アルゴリズムを平凡なテキストとしてコメントに書き留めることです。

別の解決策は、メソッドの本文をコピーしてコメント フィールドに貼り付け、それを <code> 要素に入れることです。このメソッド本体は、C# についてあまり知識がなくても非常に簡単に理解できます。そのため、テクニカル ヘルプ ファイルに記述しても問題はありません。

どちらのソリューションも DRY の原則に違反しています。情報を複製せずに、メソッド本体またはメソッド本体の一部をヘルプ ファイルに追加したいと考えています。

これはC#で可能ですか? (RDoc for Ruby はこれを行うことができると思いますが、C# での解決策が必要です)

私はc++/ cliライブラリが主にac＃アプリケーションから使用されているプロジェクトに取り組んでいます。

Visual Studio内のc＃インテリセンスにc ++ / cliのコードコメントを表示する方法はありますか？

ない場合、c＃から（そしてもちろんc ++ / cli内で）簡単に使用できるようにc ++ / cliコードを文書化するための最良の方法は何でしょうか？XMLコメントvsdoxygenvs他のツール（どちら）についてどう思いますか？