자바 논평 딜레마

Question

이것은 과제물에 대한 질문이었습니다 :

다음 중 논평을 나타내는 데 받아 들여지지 않는 것은 무엇입니까? 왜?

• /** 주석 */
• /* 주석 모두에 */
• // 주석
• // 코멘트 코멘트
• /* 주석 주석 */

솔직히, 그들은 모두 나에게 잘 보인다. 하지만 필자는이 예제에서는 여러 줄로되어 있지 않았기 때문에/** comment */일 수 있다고 생각했지만 그 목적은 문서화입니다. 어떻게 생각해? 이것이 나에게 힘든 시간을주는 유일한 질문입니다. 어떤 도움을 주시면 감사하겠습니다! 고맙습니다.

Answer 1

이 파일을 자바 파일에 넣고 각각을 컴파일 한 다음 어느 것이 오류인지를 알아야합니다. 대답을 추측 할 이유에 대해 추론 할 필요가 없습니다.

Answer 2

첫 번째 글 머리 기호 :

/** comment */ 

의견이 유형의 문서입니다. 출처 : http://journals.ecs.soton.ac.uk/java/tutorial/getStarted/application/comments.html

다른 유형의 댓글과 다르기 때문에 이것을 지적하십시오. 당신은 여러 줄 주석에 대해 맞을 수도 있습니다.

Answer 3

Java 언어 사양에는 "//"및 "/ * ... * /"의 두 가지 주석이 있음이 명시되어 있습니다.

http://docs.oracle.com/javase/specs/jls/se5.0/html/lexical.html#3.7

이 트릭 질문입니다. 그러나/** ... */이후 JavaDoc 도구를 사용하여 JavaDoc을 만들 때, 첫 번째 선택은 수용 가능한 대답이 아니라고 말할 수 있습니다.

Answer 4

문법의 관점에서 위의 설명 표시 방법 중 어느 것도 허용되지 않습니다. 그러나 다른 사람들이 자신의 코드를 더 쉽게 이해할 수있게하려면 에 몇 가지 주요 코딩 스타일을 따르라고 제안합니다.

예를 들어 Oracle coding style 은 Java의 일반적인 코딩 스타일 중 하나입니다.

코딩 스타일에는 두 가지 유형의 주석이 있습니다. 첫 번째는 구현 주석, 이며/* * /를 블록 주석으로 사용하고 // 한 줄 주석으로 사용합니다.

/* 
    * Here is a block comment. 
    */ 


    // Here is a single line comment. 

두 번째 유형은 일반적으로/** */스타일의 주석을 사용하고 는 바로 클래스, 함수 앞에 표시 및 변수 정의 문서 주석이다. 예 :

/** 
    * Documentation for some class. 
    */ 
    public class someClass { 

     /** 
     * Documentation for the constructor. 
     * @param someParam blah blah blah 
     */ 
     public someClass(int someParam) { 
     ... 
     } 
     ... 
    }