2016-09-13 3 views
11

Java 응용 프로그램의 구성 등록 정보에 "Javadoc과 같은"계측기가 있습니까?Java 응용 프로그램의 자동 등록 정보 문서

현재 Java 응용 프로그램에서 작업하고 있습니다.이 응용 프로그램은 구성에 일반적인 Java 속성 파일을 사용합니다. 이것은 "엔터 프라이즈 응용 프로그램"이므로 수십 개의 속성이 있으므로 실제로 설명서를 지원하기가 어렵습니다.

그래서 주석 (annotation)과 같은 코드의 속성을 설명하고 파일로 파일을 내보낼 수있는 도구 또는 프레임 워크를 찾고 싶습니다.

이미 Javadoc과 Swagger를 사용하고 있습니다. 매우 편리합니다. 속성과 비슷한 것을 사용하면 도움이됩니다.

+0

아마도 [this so] (http://stackoverflow.com/questions/28385079/how-to-document-properties-files)가 유용 할 수 있습니다. 프로젝트에 알맞지는 모르겠지만 확실한가? – user3159253

+0

속성은 모두 한 위치 (예 : 속성을 처리하는 일부 bean/singleton)에 있습니까? 아니면 앱의 다른 위치에서 다른 속성을 사용합니까? 또한 필드/메소드/클래스 수준에서 주석이 추가 된 속성을 찾고 있습니까? [Javadocs] (https://docs.oracle.com/javase/7/docs/api/java/lang/System.html#getProperties())는 기본 시스템 등록 정보를 다음 중 일부로 설명합니다. 그들의 javadocs. –

+0

모든 속성은 다른 클래스의 필드에 있습니다. 우리의 응용 프로그램은 플러그인 기반 아키텍처를 가지고 있으며 플러그인은 자신의 시스템 속성을 가질 수 있으므로 모든 속성을 한 곳으로 이동할 수는 없습니다. –

답변

9

등록 정보 파일 생성을 위해 PropDoc을 사용할 수 있습니다. PropDoc은 Java Properties 파일의 문서 작성 능력을 향상시키는 것을 목표로하는 유틸리티입니다.

표준 Java 특성 파일을 읽고 특성 주석에서 JavaDoc과 유사한 주석을 구문 분석 할 수 있습니다. Result는 파일의 속성에 대한 문서를 생성하는 데 사용할 수있는 메타 모델입니다.

문서를 HTML 형식으로 생성하는 기본 템플릿이 있습니다. 필요에 따라 해당 템플릿을 사용자 정의 할 수 있습니다. 매우 기본적이고 사용하기 쉽습니다.

여기에서 참조 할 수 있으며 코드는 PropDoc에서 얻을 수 있습니다.

PropDoc은 속성 파일 생성에 사용할 수있는 준비 도구입니다. 소스를 참조하여 직접 만들 수도 있습니다.

관련 문제