私はEclipseで小さなソフトウェアを書いています。 Pat Notzのように、ドキュメントを書くためにLatexを使用していて、Eclipseプロジェクトの中にそれらを入れたいと思っています。 Hereが言及されました。私が望むほとんどすべてのフォルダを使用できます。 私の場合、いくつかの特別なフォルダがありますか、それとも一般的には悪い考えで、同じプロジェクトの中にドキュメントとコードを追加していますか?Eclipseプロジェクト内でドキュメントをどこに保存しますか?
答えて
あなたのプロジェクトにはどのような言語を使用していますか? Javaを使用している場合は、javadocコメントを使用して、javadoc
を使用してAPI /ドキュメントを生成できます。また、必要な場所にドキュメントファイルを置くことも自由です。ルートディレクトリに1つのメインファイル、フォルダごとに1つのファイルを持つことができます。空は限界です!
私はJavaを使用しています。どのように文書化するかは別の話題です。私は良い文書を書く方法を考えています。データベースには、テーブルとカラムに関する独自のコメント(==ドキュメント)があります。 Javadocは、関数の仕組みを伝えるために使用されます。 TDDを実行している場合は、テストケースがAPIの使用方法を示す指標になります。したがって、私の文書(私的プロジェクト)は命名規則と一般的な側面についての短い要約として使用されています。 – user3417078
Javadocは、関数の仕組みを説明する以外にも使用されます。それを使って、クラスが何をしているのか、何ができないのか、実装の詳細、そしてあなたが望むものを説明することができます。 [List](https://docs.oracle.com/javase/7/docs/api/java/util/List.html)インタフェースを見てください。それには、クラス、使用方法、動作、その他多くの情報があります。あなたの場合、javadocまたは適切なテキストファイルを使用して、プロジェクトに関する一般的な側面と命名規則を文書化することができます。 –
- 1. どこでeclipseでオーディオファイルを保存しますか?
- 2. EclipseはSSLキーをどこに保存しますか?
- 3. Eclipseはどこに設定を保存しますか?
- 4. Eclipseツールチェーンプラグインのドキュメントはどこですか?
- 5. プロジェクト内のすべてのファイルに対してEclipseの保存アクションを実行
- 6. eclipseはクラスパス変数の値をどこに保存しますか?
- 7. eclipseはどこにNavigator View設定の設定を保存しますか?
- 8. Eclipseのプロジェクト環境設定を保存できません
- 9. Eclipseプロジェクトプロパティで「Tomcatプロジェクトですか?」設定を保存できません
- 10. Mac上のEclipseでJavaプロジェクトのデフォルトの実行コンフィギュレーションを保存するファイルはどこですか?
- 11. どこにアンドロイドの内部ストレージにデフォルトの画像を保存しますか?
- 12. Eclipseはユーザー・ライブラリーをどこに保管しますか?
- 13. Visual Studioでプロジェクトをアンロードすると、VSはこの設定をどこに保存しますか?
- 14. eclipseのZend studio - Macにプロジェクトファイルがどこに保存されていますか?
- 15. Apache Foundationはプロジェクトのチェックサムをどこに保持しますか?
- 16. Eclipseのサードパーティプラグインはどこに保存する必要がありますか?
- 17. Firefoxは保存されたパスワードをどこに保存しますか?
- 18. モバイルデータをどこに保存するのですか(大規模プロジェクト)?
- 19. xmlドキュメントをデータベースに保存しますか?
- 20. ジャスミンファイルはどこでSymfonyプロジェクトに保存すればよいですか?
- 21. Eclipseのプロジェクトで実行コンフィギュレーションを保存する
- 22. eclipseでAndroidプロジェクトのテキストファイルを保存する場所
- 23. Eclipseのローカル履歴...ファイルはどこに保存されていますか?
- 24. アップロードしたファイルをどこに保存しますか?
- 25. iCloudはどこに文書をPCに保存しますか?
- 26. VSはどこに保存されますか、どのプロジェクトが最初に読み込まれますか?
- 27. シンプルクラウドGoogleドキュメントに保存
- 28. VisualStudioはリージョンステートをどこに保存しますか?
- 29. TFSはUNITテスト結果をどこに保存しますか?
- 30. NSUserDefaultsは情報をどこに保存しますか?
実際には、これらのドキュメントを保存する場所はEclipseかJavaか、ドキュメントのフォルダ名とは関係ありません。しかし、通常、人々はそれらを 'doc'か何かに置く傾向があります。 – Rugal
私はそれをプロジェクトのルートのdocディレクトリに入れます。 –