Есть ли способ включить комментарии тела в Javadocs?

Question

У нас есть большая кодовая база Java (с примесью Groovy), для которой, по большому счету, не написано ни одного javadocs.

Однако большая часть кода достаточно хорошо документирована в комментариях «старой школы», разбросанных по всему телу.

Сейчас мы находимся в состоянии некоторого толчка, чтобы попытаться немного лучше документировать документацию - например, Javadoc теперь генерируется на регулярной основе. В качестве временной меры было бы действительно хорошо, если бы javadoc "очистил" тело класса (или функцию, или что-то еще) и бросил бы все комментарии в javadoc-заглушку.

Есть ли способ сделать это?

Answer 1

Звучит как плохая идея, учитывая, что javadocs обычно описывают назначение и использование элементов, а комментарии тела кода (или должны быть) о деталях реализации.

Но если вам нужно, вам явно нужно написать свой собственный доклет , который работает совместно с анализатором исходного файла java (либо сторонним, либо вашим). Для каждого обработанного класса вы сначала запустите анализатор исходного файла для данного java-класса и соберете внутренние комментарии, а затем увеличите (стандартный) HTML-код, созданный (стандартным) доклетом, чтобы добавить комментарии кода.

Возможная стратегия, которая помогла бы сделать результирующие javadocs разумными, состояла бы в том, чтобы включить внутренние комментарии данного метода для javadoc для этого метода. Просто используйте 'pre' замыкание и добавьте проанализированные комментарии метода в конце универсального havml-кода javadoc.