2017-04-05 103 views
1

可以创建一个自定义注释来强制一个方法拥有一个javadoc?Java注释强制写javadoc

我想创建一个注释,检查方法是否遵循特定的规则。我无法理解如何检查javadoc。

任何人都可以帮助我吗?

+0

有一些工具可以查找丢失的javadoc,但是没有任何东西可以被强制使用(除非你在你的开发者上使用了一些棒:p) – 2017-04-05 11:57:36

+0

是你监控你的源代码吗?你在用什么IDE? –

+0

我想,如果该方法不遵循规则,那么javac将在方法中使用该注释使编译失败。 –

回答

3

您可以使用checkstyle来检查包含javadoc的方法。

+0

你可以给我一个自定义注释与checkstyle lib的例子吗? –

+0

您不要创建自定义注释。 Checkstyle是一种用于检查源代码质量的工具。它可以执行的检查之一是检查你的方法是否包含javadoc。 –

1

如果您正在使用的Eclipse IDE,那么你可以设置,如果没有的Javadoc检测到的显示错误编译器标志(使用该小心,因为这是非常详细!)..

enter image description here