如何使用Java代码执行文档? - java

有哪些选项可用于强制记录代码?我想要一些可以在构建过程中运行的东西,例如一个Maven目标,它将检查代码是否已记录(类级别和方法级别),并报告是否缺少代码。

看过FindBugs,PMD和CheckStyle,但它们似乎没有提供此功能。

参考方案

好吧,我不想告诉您,但是无法使用工具强制执行有用的文档。

Checkstyle可以检查if Javadoc is present,但不能检查Javadoc是否包含@param pMyParam the myParam和其他无意义的垃圾。即使您让某些工具检查文档的内容,也会产生大量误报,并导致简单但有用的注释被夸大,仅是为了取悦检查工具。一段时间后,开发人员将在阅读代码时学会过滤掉Javadocs,就像我们在阅读网页时过滤掉广告一样。因此,如果开发人员不想编写优质而有用的文档,那么所有工具都将一事无成。

用Antoine deSaint-Exupéry的话来表达:如果您想建造一艘船,不要鼓起人们来收集木头,不要给他们分配任务和工作,而要教他们渴望无休止的浩瀚的大海。

我的建议是:使用checkstyle检查基础知识,例如每个类至少具有一个类型注释,并且接口也记录其方法。然后,对开发人员进行必要的培训,以使他们了解有意义且有用的文档,并明确指出在开发主管的眼中,高质量的代码具有高质量的文档。即使根本没有记录某些方法,Javadocs也会非常出色。然后只能通过手动检查来进行检查,例如通过同行评审或质量控制过程中某种形式化的步骤。

只是我的两分钱。

Java:正则表达式模式匹配器是否有大小限制? - java

我的模式类似于OR:“word1 | word2 | word3”我大约有800个字。可能有问题吗? 参考方案 您仅受记忆和理智的限制。 :)

Java:线程池如何将线程映射到可运行对象 - java

试图绕过Java并发问题,并且很难理解线程池,线程以及它们正在执行的可运行“任务”之间的关系。如果我创建一个有10个线程的线程池,那么我是否必须将相同的任务传递给池中的每个线程,或者池化的线程实际上只是与任务无关的“工人无人机”可用于执行任何任务?无论哪种方式,Executor / ExecutorService如何将正确的任务分配给正确的线程? 参考方案 …

JAVA:字节码和二进制有什么区别? - java

java字节代码(已编译的语言,也称为目标代码)与机器代码(当前计算机的本机代码)之间有什么区别?我读过一些书,他们将字节码称为二进制指令,但我不知道为什么。 参考方案 字节码是独立于平台的,在Windows中运行的编译器编译的字节码仍将在linux / unix / mac中运行。机器代码是特定于平台的,如果在Windows x86中编译,则它将仅在Win…

java:继承 - java

有哪些替代继承的方法? java大神给出的解决方案 有效的Java:偏重于继承而不是继承。 (这实际上也来自“四人帮”)。他提出的理由是,如果扩展类未明确设计为继承,则继承会引起很多不正常的副作用。例如,对super.someMethod()的任何调用都可以引导您通过未知代码的意外路径。取而代之的是,持有对本来应该扩展的类的引用,然后委托给它。这是与Eric…

Java:BigInteger,如何通过OutputStream编写它 - java

我想将BigInteger写入文件。做这个的最好方式是什么。当然,我想从输入流中读取(使用程序,而不是人工)。我必须使用ObjectOutputStream还是有更好的方法?目的是使用尽可能少的字节。谢谢马丁 参考方案 Java序列化(ObjectOutputStream / ObjectInputStream)是将对象序列化为八位字节序列的一种通用方法。但…