문서 java 코드

Java 용 코드 설명서를 무료로 제공하는 프로그램이 있습니까? 코딩 프로젝트를 완료하고 문서를 작성하는 데 충분한 시간이 필요합니다. 알고 계시면 알려주십시오.문서 java 코드

2009-09-30 gingergeek

javadoc이 "괜찮은"것이 아니라고 하시겠습니까? "괜찮은"의미는 무엇입니까? "괜찮은"것에 대한 몇 가지 유용한 정의를 제공해주십시오. –

대부분의 대답은 javadoc 주석을 생성 한 후 문서를 렌더링하는 javadoc을 가리 킵니다. 그러나 javadoc 주석 생성에 대한 질문이 아닙니까? – quosoo

나는 그것을 말할 것이다 : javadoc은 괜찮지 않다. 주석을 컴파일하고 나면 도움이됩니다. 소스 양식은 사실상 읽을 수 없습니다. html의 하위 집합을 사용하기로 한 결정은 독창적이었습니다. wiki 나 심지어 여기에 사용 된 마크 업과 같은 것이 훨씬 더 좋았을 것입니다. – CPerkins

javadoc은 Java 소스 코드 문서 용 표준 도구 (JDK에 포함)입니다.

standard Java API documentation은 javadoc을 사용하여 생성되었습니다.

출처

2009-09-30 11:34:46 Jesper

음,

확실히 javadoc있다. 나는 이것이 자바 프로젝트를 문서화하는데 가장 많이 사용되는 도구라고 생각한다. 또한 메소드와 클래스를 문서화 할뿐만 아니라 정적 HTML 페이지로 자습서를 문서화/작성할 수 있다는 점을 고려하면 생성 된 문서에 나타납니다.

출처

2009-09-30 11:36:58 Marc

Java (Javadoc)는 Java의 표준 도구입니다. 그러나보다 강력한 코드 탐색 기능과 렌더링 옵션을 제공하는 Doxygen을 확인하시기 바랍니다.

출처

2009-09-30 11:37:36

javadoc은 커스터마이징이 가능하고, javadoc 툴용 도크 렛 - 플러그인을 통해 확장 할 수 있습니다. http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/doclet/overview.html – Jesper

자동으로 생성 된 설명서가 좋지 않습니다. 왜 그걸 가지고 있니? 어떤 가치도 추가하지 않습니다.

출처

2009-09-30 11:44:35 erikkallen

@all downvoter : 항상 downvote에 대한 이유를 알려주십시오. 그것은 다른 사람들을 도울 것입니다. 사실 나는이 답변이 저자에게 매우 도움이되지는 않지만 erikkallen이 유일한 질문이라고 생각합니다. 나에게 gingergeek는 javadocs를 자동으로 생성 할뿐만 아니라 자동으로 생성하려고한다. – quosoo

답변이 도움이되지 않아서 질문에 대한 유용한 대답이 아니기 때문에 당신은 다운 voted입니다. 또한 컴퓨터가 문서를 자동으로 생성 할 수는 없습니다. 컴퓨터가 클래스 나 방법을 인간의 언어로 기술 할 수 없기 때문입니다.직접 작성해야합니다. 많은 IDE가 클래스, 메소드 등에 빈 javadoc 블록을 추가하는 것을 도와줍니다. – Jesper

@Jesper : 그래서 당신은 에릭 콜렌의 대답에 동의했습니다. 그러나 어쨌든 당신은 대답의 형태와 설명의 부족을 이유로 그를 내렸다. 실제로 나에게 공평하게 들린다. – quosoo

가장 많이 사용되는 IDE (예 : Eclipse, NetBeans)는 javadocs를 생성합니다. getter 및 setters와 같은 분명한 목적의 메서드의 경우 충분한 매개 변수 (예 : getX() "Gets x"등)도 생성합니다. getter, setter 또는 기본 생성자보다 정교한 클래스 및 메소드에 대한 javadoc 주석을 완료하는 것보다 수행해야 할 작업은 다음과 같습니다.

예를 들어 코드 구조를 설명하는 UML 다이어그램을 생성하는 데 사용할 수있는 많은 플러그인 (Eclipse 용 here 참조)도 있습니다.

출처

2009-09-30 12:05:00 quosoo

10 년 이상 TallTree의 DocJet (http://www.talltree.com/)을 사용하여 Java/C++ 코드에서 기술 문서를 생성하고 매우 만족스러운 결과를 얻었습니다. 이 도구는 javadoc 태그를 인식 할 수 있지만 특별한 태그가 필요하지 않습니다. 'return'(또는 같은 의미의 다른 표현), '매개 변수'또는 '인수'등과 같이 가끔 나오는 문구를 사용하여 일반 영어로 클래스/메소드/필드를 설명하기에 충분합니다.

출처

2009-11-30 14:42:36 Darko

문서 java 코드

답변

관련 문제