내 클래스에 메서드 정의를 작성하는 법을 배우고 싶습니다. 예 :Java Writing Method Definition
public int myMethod()
{
//This method is used for ....bla bla bla....
}
나는 어떤 방법으로 사용자에게 알리고 싶습니다. .Net에서이 정의를 작성할 수 있으며 메소드를 작성할 때 설명을 볼 수 있습니다. JAVA로 어떻게 할 수 있습니까?
/**
* This method is used for..
*/
public int myMethod()
{
}
, params가에 대한
은 다음과 같이 사용합니다 :에 대한 자세한 내용은 링크입니다.
첫 번째 문장은 "어떻게 수행합니까?"e.q. "foobar를 만듭니다."라는 질문에 대한 제 3자가 선언문이어야합니다. 또한 첫 번째 문장이 요약 설명으로 사용되므로 가능한 한 명확하고 간결해야합니다. - 불필요한
/**
* Reads in config file and initializes application.
*
* @return Application status; 0 if everything is okay.
*/
public int myMethod() {
// ...
}
IMO 추가 불필요한 세부 사항은 즉 :
는 예를 들어, 방법은 파일에 읽고 있다면 것은 정수 상태를 반환했습니다. 일부 메소드는 자체 문서화이며 getter/setter 인 표준 예제는
/**
* Sets first name.
*
* @param firstName Name to set.
*/
public void setFirstName(String firstName) {
this.firstName = firstName;
}
중복 주석입니다. 이와 유사하게, 잘라는 이름의 방법은, 광대 한, 또는 문서를 필요로 방지 할 수 있습니다
public List<User> getAllUsers() { ... }
public User findUserById(Long id) { ... }
을 IMO 사실은 놀라운 일이 아니라면, 발언 할 필요가 없습니다.
HTML은 Javadocs를 마크 업하는 데 사용되지만 IMO는 여러 형식 (편집기, IDE, Javadocs 등)으로 읽을 수있는 방식으로 형식을 지정하여 들여 쓰기를 사용하는 것이 좋습니다 공백으로 모든 것을 평범한 텍스트로 볼 수 있고 렌더링 할 수 있는지 확인하십시오.
표준 도크 렛은 HTML을 사용합니다. <p> 또는 <br> 태그를 통해 명시 적으로 지정하지 않으면 공백이 무시됩니다.
/**
* Builds and returns the current list of ingredients.
*
* <p>
* <b>Note:</b> Initializes ingredient information if necessary.
* </p>
*/
유용한 링크 :
이 방법을
/**
* This method is used for..
* @param v pass this to do something
*/
public int myMethod(Object v)
{
}
완전한 세부 사항 : oracle.com
그것은 당신이 문서화해야하는 경우 함수 전에 Javadoc를 사용하는 것이 유리입니다 그것. 이동 입력하면/** 입력하면
/**
* This method is used for ....bla bla bla....
*/
public int myMethod()
{
}
이클립스는 자바 독 방법 서명 코멘트를 자동 생성하고 공격 :
/**
* Does [fill in the blank here]
* @return An integer stating [what it does]
*/
public int myMethod() {
// Fill in the rest here
}
하는 방법 위/** ... */주석로 추가 다음 줄로.
(일부 사용 빈도가 낮은 Javadoc의 트릭을 포함한다) 사람이 IDE를 사용하고있다 (Eclipse는 제외)? – Makoto
@Makoto JavaDoc은 IDE와 관련이 없으며 http://en.wikipedia.org/wiki/Javadoc도 필요하지 않습니다. 일반적으로 다음과 같이 HTML로 바뀝니다. http://docs.oracle.com/javase /1.5.0/docs/api/java/lang/String.html –
@Makoto 이클립스가 그렇게하겠다는 보장은 없으며 아마도 Netbeans/IntelliJ 일 것이다. 그들이 더 잘 모르는 한 왜 IDE를 사용하지 않을지 확신하지 못합니다. 편의를 제공하고 개발 속도를 높이는 도구를 싫어하거나, vi가/emacs/Textpad/Notepad/Xcode에서 개발하여 선을 달성했다고 생각합니다./etc/etc. –
How to Write Doc Comments for the Javadoc Tool을 참조하십시오. (기본적으로 Javadocs라고하는 것을 찾고 있습니다.)
몇 가지 예를 보려면 다른 답변을 참조하십시오.
이 문제를 해결하려면 javadoc 주석을 사용해야합니다. 아래
/** * This method is used for.. */ public int myMethod() { }
같은 뭔가가 여기에 다른 답변의 일부를 구체화 Javadoc의 방법 Javadoc methods
감사합니다. 그게 잘 작동합니다 ... – ahmet