우리는 실제 인코딩에서 항상 프로그램에 주석을 추가해야 한다.
주석이란 무엇입니까?주석은 한 단락의 문자로 이 단락의 문자는 반드시 필요한 것이 아니며 코드 운행에 직접 참여하지 않는다.
주석은 특정한 단락의 코드의 작용을 설명하거나 특정한 종류의 용도, 각 방법의 기능, 그리고 이 방법의 매개 변수와 반환값의 데이터 유형과 의미 등을 설명하는 데 쓰인다.
주석을 추가하는 이유
1. 자신의 이해력을 너무 믿지 마라.시간이 지나면 자신의 이전 코드를 간단명료하게 이해할 수 있도록 주석을 추가하는 것을 권장합니다.
2, 가독성 1위, 효율 2위.팀 협동 개발에서 팀 구성원의 소통이 비교적 중요하기 때문에 자신이 쓴 코드가 전체 팀에 이해될 수 있도록 주석을 추가하는 것을 권장한다.
3, 코드는 문서입니다.자신이 평소에 코드를 쓰는데, 규범화된 문서를 만들기 위해 주석을 추가하는 것을 권장합니다.
실제 업무 중에 몇몇 동료들이 다른 사람의 코드에 주석이 없으면 어떻다고 말하는 것을 자주 듣는다. 실제로 예쁜 코드는 주석이 많이 필요하지 않다. 반대로 나는 개인적으로 화면이 가득한 주석이나 쓸모없는 코드에 대해 매우 반대이다.
특히 git, svn 등의 도구를 사용하여 버전 관리를 한 후에 나는 쓸모없는 주석을 지운 코드를 모두 삭제할 것이다.
여기에 주석에 대한 나의 개인적인 이해를 정리해 보자.
1. 필요한 주석은 반드시 있어야 한다. 예를 들어 자바빈의 필드 의미는 관련 주석이 있어야 한다.예를 들어 일부 인코딩에서 일시적으로 기능을 실현하지만 최적화를 기다리는 데 좋지 않은 부분이 존재하기 때문에 나는 보통 하나를 쓴다
TODO, 기본적인 기능을 실현한 후에 내가 다시 돌아서서 보완할 것이다.
2. 바보의 쓸모없는 주석을 쓰지 마라. 주석된 코드를 한 줄도 남기지 마라. 현재 코드는 일반적으로 버전 도구로 관리하기 때문에 코드를 잃어버릴 염려가 전혀 없다.
3. 자바의 명칭 규범을 엄격히 준수하고 변수의 명칭이 너무 길까 봐 걱정하지 않으며 방법의 명칭이 너무 길까 봐 걱정하지 않는다. 합리적인 영어의 번역 명칭은 쓸모없는 중국어 주석을 쓰는 것보다 훨씬 낫다.
프로그램 주석은 원본 코드의 중요한 부분으로 규범화된 프로그램 원본 코드에 대해 주석은 원본 코드의 3분의 1 정도를 차지해야 한다.
거의 모든 프로그래밍 언어가 주석 기능을 제공하고 일반적인 프로그래밍 언어는 기본적인 단행 주석과 다행 주석을 제공하며 자바도 예외가 아니다.Java 언어는 이 외에도 문서 주석을 제공합니다.
이 블로그는 먼저 자바의 단행 주석과 여러 줄 주석을 정리합니다. 문서 주석은 일반적으로 API를 만드는 데 사용됩니다.
다음에 저는 자신의 프레임워크를 관련 API로 정리할 것이기 때문에 자바에 대한 문서 주석을 작성할 것입니다. 다음에 저는 블로그를 전문적으로 쓸 것입니다.

단일 및 여러 줄 주석

일방통행 주석은 프로그램에서 한 줄의 코드를 주석하는 것으로 자바 언어에서 주석이 필요한 내용 앞에 쌍사선'//'를 놓으면 된다.
eclipse에서 단행 주석의 단축키는command +/이고, 한 번 누르면 주석을 추가하고, 한 번 누르면 주석을 취소합니다.
여러 줄 주석은 프로그램의 여러 줄 코드를 한꺼번에 주석으로 표시하는 것이다. 자바 언어에서'/*'와'*/'를 사용하여 프로그램에서 주석이 필요한 내용을 포함하고'/*'는 주석이 시작되고'*/'는 주석이 끝난다는 것을 의미한다.
eclipse에서 다행 주석의 단축키는command+control+/입니다. 사용할 때 코드를 선택해야 합니다. 저는 보통 다행 주석을 거의 사용하지 않습니다.
Java의 한 줄 주석과 여러 줄 주석을 보여 주는 코드를 붙여 넣습니다.

/** * Java          . *  * @author LinkinPark */public class Comment{ public static void main(String[] args) {  //    Java       System.out.println("  Java     。。。");  /*   *    Java        */  System.out.println("  Java     。。。"); }}