2011-07-21 10 views
2

私は、非常に少ないドキュメンテーションとそれもコメントの形式のプロジェクトに取り組んでいます。このことは私の時間を無駄にしています。私はSource Insightのようなツールの助けを借りてコードを作業しています。最終的にはうまくいくが、何人かの新しい人が来たら、同じプロセスをやり直さなければならないだろう。それを変更するために、私はこのことを文書化することを開始したい。ドキュメントを作成するためのソフトウェア? (大規模なソースコード)

コードはCおよびC++で、GB単位で保存されています。私はそれを文書化するためのツール(無料)を探しています。私はWikiを使うことを考えましたが、私はそれを手作業で作って、ページを作成し編集する全プロセスが長くて面倒であるとは思いません。私は知識の中にダンプすることができるツールを必要とし(多分それにタグを付けるかもしれない)、それは検索の機能を提供する。私はまた、ローカルLANに更新しておきたい。

何か提案がありますか?

答えて

7

あなたはDoxygenの無料で優れた使用を検討する必要があります。

+0

+1 [doxygen](http://www.stack.nl/~dimitri/doxygen/)。このような質問をしたのは私の最初の電話帳です。私たちは夜間ビルドの一部として実行中のdoxygenを組み込んだので、ソースコードの24時間以内にすべてのビルドでドキュメントを実行するのは時間がかかりすぎていました。 –

+0

私はそれを検討していますが、どのように検索機能を提供しますか? – Ankit

+0

@Ankit:["クラスやメンバーのドキュメント(PHPベース)の文字列や単語を検索するための高速ランクベースの検索エンジンが含まれています。"](http://www.stack.nl/~dimitri/doxygen/features .html) –

0

Doxygenは、非常に人気のある無料のソースコードドキュメントツールです。使用が簡単で、HTML、Latex XML、MS Helpなど、いくつかの異なるフォーマットでドキュメントを生成します。

0

ドキュメントのためのDoxygen。 OpenGrokを検索に使用します。複数のプロジェクトにインデックスを付けることができ、非常に高速です。

関連する問題