您是否应该在开始编程之后或之前编写javadoc？

Question

我认为javadocs很漂亮。清楚每种方法和类的描述。我们的测试人员可以轻松编写单元测试，无需程序员重复解释。

这就是我们在初创公司实践TDD的方式。我们首先坐下来规划应用程序结构，然后开始创建所有方法和类（无需编程），我们使用javadoc向类，构造函数和方法添加描述。然后我们将其发送给编写单元测试的测试人员。当他完成后，我们开始编程。

没有人在抱怨。我们的测试人员爱上了javadoc，虽然他是一个可怕的程序员（这就是他成为测试人员的原因），但他可以很容易地理解javadoc并编写junit-tests。

问题是，我们大多数人都是初创公司的新手。在我们开始编程之前，我不知道你是否应该记录所有的类和方法？我对你更有经验的程序员的问题是：这是一个很好的TDD方法吗？

Answer 1

TDD很有用，因为它确保您不会错过任何要求。它最终被用作单元测试用例，当程序员开始工作时，他们需要确保涵盖所有测试用例。

测试人员编写系统＆amp;集成测试用例。

来到javadoc，理想情况下应该是必须的。它删除了代码重复/可重用性，并为系统文档增加了一些价值。

Javadoc应该描述返回类型，输入参数以及在方法中执行的过程。