2

ドキュメント化されていない 100.000 行の Delphi 7 プロジェクトに取り組んでおり、私の目標の 1 つは、ソース コードからソフトウェア アーキテクチャ ドキュメントを作成することです。

これにアプローチする方法について何かアイデアを教えてもらえますか?

4

3 に答える 3

2

これらのツールは Delphi 7 で動作し、非常に役立ちます。

UML ダイアグラムは、構造の概要を把握するのに最適な方法です。その概観がどれだけうまくいくかは、構造がどれだけうまくいくかにかかっています。

このようなプロジェクトを引き継ぐために、いくつかの基本的なドキュメントから始めます (多くの場合、テキスト ベースの形式はバージョン管理しやすく、適切な HTML を生成するMarkDown 形式です)。

それを実現するには、元の開発者または/およびいくつかの基本ドキュメントがまだそこにあると役立ちます。

次に、次のことを始めます。

  • バグ修正 / 機能リクエストの適用
  • ModelMaker を使用して全体の構造を把握する
  • ModelMaker Code Explorer をリファクタリング ツールとして使用する
  • ドキュメンテーション インサイトを使用してソース コード内を文書化します (プロ バージョンではヘルプ ファイルと Web ページを生成できます。機能マトリックスを参照してください) 。
  • ソース コードのドキュメントにうまく収まらない情報で Markdown ドキュメントを更新する

Model Maker Code Explorer を使用して一部のドキュメンテーションを配置できますが、ドキュメンテーション インサイトとは異なるドキュメンテーション形式を使用するため、ヘルプ ファイルとしてエクスポートすることはできません。

したがって、Jan Doggenのコメントに同意します(Jan に感謝します!): 開始するだけです。そのための適切なツールがあることを確認してください。

于 2013-08-15T10:19:57.900 に答える
1

理解して仕事をします。無料ダウンロードには 15 日間の評価版が含まれており、文書化するのに十分です。

于 2013-08-15T11:03:20.987 に答える