Question

我们发现了 Java的大型密码库(Groovy混合体的配对),基本上没有为此撰写的 j。

然而,该法典的大部分内容在全机构散布的“旧学校”评论中得到了合理的记录。

我们现在回头来的是,推动尝试和获取记录得更好一些东西——例如,Javadocs正在定期产生。作为权宜之计,如果javadoc将“摇.”这一类的体体(或功能,或不管怎样),并将所有意见归入“stub” j。

是否有办法这样做?

Answer 1

鉴于javadocs通常描述要素的目的和用途,而编码机构的评论(或应当)是关于执行细节的。

有助于使由此产生的 j马docs(docs鱼)敏感化的一项可能战略是,为这种方法列入某种方法的内部评论。在通用javadoc html的末尾,仅使用预先关闭,并附上对这种方法的 par评论。