0

私の会社はいくつかのプロジェクトを開発しました。時間の経過とともに、特定の機能が複数のプロジェクトに複数回実装されていることがわかりました。

現在、共通コードを再利用可能なコンポーネントに抽出することを目指しています。

ただし、すべての再利用可能なコンポーネントのカタログとして機能するツールが必要です。これにより、開発者は、機能がコンポーネントにすでに実装されているかどうかを検索する必要があるときはいつでも、この「再利用可能なコンポーネント」ツールを検索でき、見つかった場合は次のように読むことができます。このコンポーネントの機能の簡単な説明。

私の質問は、再利用可能なコンポーネントを文書化するために使用できる無料のツールはありますか?

ありがとう...

4

2 に答える 2

0

はい、 doxygenJavadocなどの無料のツールがあり、コードやコンポーネントの文書化に役立ちます。

ただし、このようなツールはすべて、プログラマーの支援が必要です。私が言及した両方のツールは、特定の形式のコードでコメントを作成する際に、いくつかの規律を順守する必要があります。特別に注釈が付けられていないコードからの有用なドキュメントの自動生成は、利用可能な(無料または高価な)ドキュメントツールの機能をはるかに超えていると自信を持って断言します。

使用しているプログラミング言語やその他のツールの詳細を使用して質問を編集すると、これよりも役立つ回答が得られる場合があります。

于 2012-10-01T13:15:14.043 に答える
0

あなたはウィキを探していると思います。

たとえば、DokuWikiを見てください。それは自由なソフトウェアです。PHPを備えたサーバー(データベースなし)のみが必要です。

各スニペット/コンポーネントは、独自のページに配置できます(構文が強調表示されたコードのマークアップが利用可能です)。そして、あなたはすべてのページをリンクすることができます。そのため、ページをリンクすることで、ニーズに合った構造を整理します。

すべてのユーザーがページを編集できます(許可する場合)。また、Wikiへのアクセスを制限することができます(したがって、従業員だけがWikiを読んだり編集したりできます)。


もちろん、他にも多くのウィキソフトウェアがあります。

于 2012-10-02T13:02:42.470 に答える