2017-12-04 3 views
0

.groovy 파일 집합 (Java)이 있습니다. 이 파일들은 모두 같은 주석 형식을 가지고 있습니다. 나는 그 파일을 읽고 REGEX를 적용하여 목록의 모든 주석을 얻을 수있는 도구를 개발했습니다. (마지막으로 나는이 주석을 .html 파일에 붙여 넣기 만 복사하면됩니다.) 주석 (문서 종류)이있는 HTML 페이지를 생성하려면 올바른 방법인지 알고 싶습니다. 그렇지 않다면 무엇을 권하겠습니까? 그루비 파일의 자바 주석을 html 형식으로 구문 분석하는 방법은 무엇입니까?

나는 Doxygen을하고 자바 독에 대해 읽어하지만 난 생성하기 위해 당신이 라이브러리를 제안 할 수있는 경우

(그들은 코멘트가 이미 작성되어 있기 때문에 내 경우에는 정말 유용 할 수있는 경우)를 사용하는 방법에 대한 확실하지 않다 쉽게 HTML 웹 페이지 또는 기타 조언.

도움을 주시면 감사하겠습니다.

답변

3

그루비 (Groovy)의 경우 대략 Javadoc에 해당하는 Groovydoc이 있습니다.

설정이 (이미 Groovydoc 형식이 아닌 주석이 있고 툴링의 절반을 사용하고 있기 때문에) 여러 가지 방법으로 사용할 수 있습니다. Groovy에서 이미 문서를 추출한 것처럼, 내가 원했던 경우, 필요한 경우 최소 서식 지정을 수행하고 설명서를 양도 감 (예 : github markdown) 또는 asciidoc (예 : asciidoctor)으로 출력합니다. 그런 다음 원하는 모든 도구를 사용하여 형식이 지정된 문서를 HTML로 변환 할 수 있습니다.

"Java 주석을 구문 분석하는 방법"질문에 대답하려면 - 그렇게해서는 안됩니다. 가능한 경우, 특히 새 프로젝트에서 표준 공구를 사용하십시오. Groovy의 경우 Groovydoc입니다. 일반 (Java/Groovy-Doc 스타일이 아닌)은 소스 코드에서 추출 할 필요가 없다고 스스로 의견을 말합니다. 그것들은 너무 많은 문맥에 따라 달라야하며, 대응 코드가 없다면 어쨌든 쓸모가 없다.

+1

: +1 : groovydoc 메커니즘을 사용하여 [문서의 모든 예제를 테스트하십시오.] (http://blog.bloidonia.com/post/38376843422/automated-javadoc-testing-in-gradle -built-groovy) :-) –

+0

도움을 주셔서 감사합니다. Groovydoc을 다운로드하고 설명서도 열었습니다. 그러나 나는 문제에 직면하고있다. 내 그루비 파일은 매우 간단 /* --- TITLE --- */ /* - 방법 1 - */ 어떤 방법 N 까지 코드 ... 그러나 생성 된 HTML이 비어 명령 줄이 올바른 것으로 보입니다. –

관련 문제