일반 JavaDoc 질문 : 작동하는지 어떻게 알 수 있습니까? 형식과 그들이해야 할 일을 알고 있지만, 그들이 일을하는지 어떻게 알 수 있습니까? 컴파일하고 실행 한 후에 출력해야합니까?Java 입문 (신규) - 일반 JavaDoc 문제
또 다른 질문 - 얼마나 많은 JavaDoc 주석이 필요합니까? 교수님은이 논평에서 우리의 방법을 시험하고 모든 변수를 설명하기를 바랍니다. 그것은 그 방법 안에 넣는 것을 의미합니까? 또는 방법 앞에 있지만 클래스 안에 있습니까? 아니면 수업 전에?
도움 주셔서 감사합니다.
저는 실제로 JavaDoc이 실제로하는 일에 다소 혼란 스러울 수도 있습니다.
JavaDoc은 어쨌든 프로그램에 직접적인 영향을주지 않습니다. JavaDoc은 프로그램에 대한 정보를 컴파일하는 수단입니다. 프로그램을 작성하고 문서가 유용한 형식으로 문서화되기를 원한다고 가정 해보십시오. 이클립스와 같은 일반적인 컴파일러는 Java API 문서에 표시된 것처럼 문서로 가득 찬 HTML 파일을 컴파일 할 수있는 옵션이 있습니다. 이것은 모두 JavaDoc이며 대부분 주석으로 생성됩니다.
내 선생님은 항상 의견과 관련하여 코드를 읽지 않는 사람에 대해서는 언급하지 않습니다. 당신은 같은 .... 프로그래머가 이미이 기능을 알고
// Prints out hello world
System.out.println("hello world");
의견이 필요하지 않습니다. 프로그래머는 매개 변수 이름과 실제로 어떤 기능이 더 많은지 관심이 있습니다. 예
/**
* @param a Number we are dividing into
* @param b Number we are dividing by
* @return Our quotient
*/
public static float divide(int a, int b) {
return (a/b); }
는/** 상단에 두 개의 별표 아래의 JavaDoc 포함되어 있음을 나타내는 온이 
강조와 같은 페이지를 생성합니다. Eclipse와 같은 대부분의 IDE는 JavaDoc을 강조합니다. 
매개 변수의 이름이 a와 b이므로 매개 변수 이름에 함수의 이름을 붙이기가 어렵 기 때문에 JavaDoc을 사용하여 매개 변수의 설명을 제공하는 시간을 절약 할 수 있습니다 사람들이 코드를 스크롤하여 도대체 그들이 무엇을하는지 알아 내려고합니다. 프로그램을 수정하고 업데이트하기위한 가이드를 작성 중입니다.
JavaDoc은 말 그대로 프로그램에서 모든 함수, 클래스, 변수가 작동하는 방법을 안내합니다.