2016-04-11 15 views
1

私はEclipseで小さなソフトウェアを書いています。 Pat Notzのように、ドキュメントを書くためにLatexを使用していて、Eclipseプロジェクトの中にそれらを入れたいと思っています。 Hereが言及されました。私が望むほとんどすべてのフォルダを使用できます。 私の場合、いくつかの特別なフォルダがありますか、それとも一般的には悪い考えで、同じプロジェクトの中にドキュメントとコードを追加していますか?Eclipseプロジェクト内でドキュメントをどこに保存しますか?

+3

実際には、これらのドキュメントを保存する場所はEclipseかJavaか、ドキュメントのフォルダ名とは関係ありません。しかし、通常、人々はそれらを 'doc'か何かに置く傾向があります。 – Rugal

+0

私はそれをプロジェクトのルートのdocディレクトリに入れます。 –

答えて

1

あなたのプロジェクトにはどのような言語を使用していますか? Javaを使用している場合は、javadocコメントを使用して、javadocを使用してAPI /ドキュメントを生成できます。また、必要な場所にドキュメントファイルを置くことも自由です。ルートディレクトリに1つのメインファイル、フォルダごとに1つのファイルを持つことができます。空は限界です!

+0

私はJavaを使用しています。どのように文書化するかは別の話題です。私は良い文書を書く方法を考えています。データベースには、テーブルとカラムに関する独自のコメント(==ドキュメント)があります。 Javadocは、関数の仕組みを伝えるために使用されます。 TDDを実行している場合は、テストケースがAPIの使用方法を示す指標になります。したがって、私の文書(私的プロジェクト)は命名規則と一般的な側面についての短い要約として使用されています。 – user3417078

+0

Javadocは、関数の仕組みを説明する以外にも使用されます。それを使って、クラスが何をしているのか、何ができないのか、実装の詳細、そしてあなたが望むものを説明することができます。 [List](https://docs.oracle.com/javase/7/docs/api/java/util/List.html)インタフェースを見てください。それには、クラス、使用方法、動作、その他多くの情報があります。あなたの場合、javadocまたは適切なテキストファイルを使用して、プロジェクトに関する一般的な側面と命名規則を文書化することができます。 –

関連する問題