在类的JavaDoc中包括(单元)测试类的链接是一种好习惯还是一种好习惯？

到目前为止,我还没有看到它,但是发现它在上课和测试课之间跳转时非常有帮助.我还认为测试用例为使用类提供了很好的例子.

在JavaDoc中反对链接测试用例的论点是什么？

解决方法:

绝对不是好习惯.

出于一个简单的原因：生产代码的责任在于其“生产工作”.生产代码不负责提供有关测试设置的信息！有时,有一种受程序包保护的方法很实用,该方法允许您检查对象的内部状态-使单元测试更加容易.但这是使测试更容易/可行的方法.含义：这样的事情是可以接受的(当不落水的时候)-但是这个想法是不可接受的.

即使您忽略了这一点,“标准”实践也是将单元测试放在单独的独立程序包中.因此,您获得了两个带有类/包“ x.y.Z”的产品,并使用“ x.y.ZTest”进行了测试.并且：当然,从测试到生产应该只有一个依赖关系-而不是另一个方向. Javadoc中的“真正链接”(例如{@link SomeClass})将要求您具有这种依赖性.您不能链接到项目设置中编译器无法解析的类！

除此之外：如果您按照上述建议的项目布局进行布局,那么您始终会知道：“如果有针对类Z的测试-则该测试应命名为ZTest”.任何体面的想法都会为您找到ZTest.

换句话说：当我想在eclipse中查看某个类的测试时,我只需双击该类的名称(以选择该名称)即可；然后我按“ ctrl-shift-t”(打开类型)… eclipse向我展示了两个类：Z和ZTest.

长话短说：确保您使用的是标准程序,并准备有可以为您解决此类问题的工具,而不是用不属于此的信息污染您的生产代码.干净的代码很重要的原因：必须理解源代码中的每一行都代表成本.必须修复错误或增强功能的人员必须读那行(可能非常频繁).因此：任何不支持班级核心职责的事物都不应存在.