Export Endpoints/User Documentation
已回答
Hi all,
I've been a long time user of phpStorm, but I've been assigned a new project using Java 8/Maven/Angular, I'm slowly getting up to speed.
One thing on my list is documentation, the Endpoints tool gives some great documentation for the user end points, I was wondering if there is a way to export all the paths it finds? I was thinking then of adding @Description to describe the end point in detail, would that be a standard way?
Also is there any other suggestions of the best way to document parts of the code which can then be swept with IntelliJ Ultimate to generated user documentations thus reducing manual effort release on release?
Many thanks and sorry if any of this is obvious.
请先登录再写评论。
IntelliJ IDEA supports JavaDoc generation. If JavaDoc produced documentation is fine for you, then go ahead and use it. Otherwise you may want to use some third-party solutions for documenting your project.
There is no way to export all the Spring endpoints at the moment, request is welcome at https://youtrack.jetbrains.com/newIssue?project=IDEA .