Where to store documentation inside an Eclipse project?
我正在用 Eclipse 编写一个小软件。像 Pat Notz 一样，我使用 Latex 编写文档并希望将它们包含在我的 Eclipse 项目中。这里有人提到，我几乎可以使用我想要的每个文件夹。
在我的情况下是否有一些特殊的文件夹，或者一般来说这是一个坏主意，在同一个项目中添加文档和代码？
- 实际上，这些文档的存储位置取决于您的决定，Eclipse 或 Java 与文档的文件夹名称无关。但通常人们倾向于将它们放在 doc 或其他地方。
-
我会将它放在项目根目录下的 doc 目录中。
您的项目使用什么语言？如果您使用 Java，您可以使用 javadoc 注释，然后使用 javadoc 生成 API/文档。您还可以自由地将文档文件放在您想要的任何地方。你的根目录可以有一个主文件，每个文件夹一个文件，没有限制！
- 我正在使用 Java。如何记录是另一个话题。我正在考虑如何编写一个好的文档。数据库对表和列有自己的注释(== 文档)。 Javadoc 用于说明函数是如何工作的。如果您正在运行 TDD，那么您的测试用例就是如何使用 API 的指标。所以我的文档(一个私人项目)被用作关于命名约定和一般方面的简短摘要。
-
Javadoc 不仅仅用于解释函数的工作原理。你可以用它来解释一个类做什么，它不做什么，一些实现细节，任何你想要的。看一下List界面。它包含有关类、如何使用、它的作用以及更多内容的信息。对于您的情况，您可以在任何您认为合适的地方使用 javadoc 或文本文件来记录有关您的项目的一般方面和命名约定。