Образец / шаблон Javadoc на платформе Spring и файл html / xml - PullRequest
0 голосов
/ 10 октября 2018

Теперь работаем над проектом J2EE, используя Spring Framework в Eclipse.Мы хотели бы подготовить исходный документ от Javadoc и задать следующие вопросы: 1) Поскольку среда Spring использует много аннотаций и трудна для новичков, любой шаблон документа / руководство по написанию исходного документа, чтобы егоновичку легче следовать?

2) Помимо файла .java, в нашем проекте задействовано много файлов html (с Thymeleaf) и xml, поэтому мы хотели бы также сгенерировать документацию для этих файлов html / xml.(многие параметры в файле persistence.xml трудно соблюдать через 2 недели, если они не задокументированы). Любой метод для JavaDoc для поддержки этих файлов html / xml?

3) Если не использовать JavaDoc, любые другие компоненты вЗатмение для документации?

Спасибо.

LAM Chi-fung

1 Ответ

0 голосов
/ 10 октября 2018

Я думаю, вам нужно больше, чем только JavaDoc, поэтому, пожалуйста, взгляните на AsciiDoc и его расширения.

...