독서 노트 의 프로 그래 밍 스타일 - 주석

주석
주석 은 코드 에서 가장 흔히 볼 수 있 는 구성 부분 이다.그것들 은 또 다른 형식의 문서 이자 프로그래머 가 마지막 에 야 시간 을 들 여 쓴 것 이다.그러나 코드 의 전체적인 유지 가능성 에 있어 주석 은 매우 중요 한 일환 이다.적당 한 주석 을 추가 하면 코드 의 경 위 를 설명 할 수 있 고 다른 개발 자 들 은 코드 를 처음부터 읽 지 않 고 코드 의 임 의 부분 을 직접 읽 을 수 있 습 니 다.
JavaScript 는 두 가지 서로 다른 유형의 주석 을 지원 합 니 다. 한 줄 주석 과 여러 줄 주석 입 니 다.
단행주석
두 사선 이 시작 하여 줄 끝 날 때 까지.

//         

[스타일]: 많은 사람들 이 쌍 사선 뒤에 빈 칸 (나 도 좋아) 을 두 드 려 서 주석 텍스트 가 어느 정도 이동 하 는 것 을 좋아 합 니 다.
【 사용 방법 】:
4. 567917. 한 줄 을 독점 하 는 주석 으로 다음 줄 의 코드 를 설명 합 니 다.이 줄 주석 은 항상 빈 줄 이 있 고, 들 여 쓰기 단계 와 다음 줄 코드 가 일치 합 니 다
코드 줄 의 끝 에 있 는 주석코드 가 주석 사이 로 끝 날 때 까지 최소한 하나의 들 여 쓰기 가 있 습 니 다.주석 (이전 코드 부분 포함) 은 한 줄 의 최대 문자 수 제한 을 초과 해 서 는 안 됩 니 다. 초과 하면 이 주석 을 현재 코드 줄 위 에 놓 습 니 다
4. 567917. 주석 이 달 린 큰 코드..
[주의]: 한 줄 의 주석 은 코드 를 주석 하지 않 는 한 여러 줄 의 주석 으로 나타 나 서 는 안 됩 니 다.
[예시]:

//     
if (condition) {
    
    //          ，             
    allowed();
}

//      ：        
if (condition) {
    //          ，             
    allowed();
}

//      ：     
if (condition) {

//          ，             
    allowed();
}

//     
var result = something + somethingElse; // somethingElse        null

//      ：           
var result = something + somethingElse;// somethingElse        null

//     
// if (condition) {
//     doSomething();
//     thenDoSomethingElse();
// }

//      ：         
//            ，  ，        
//                   
//          ，        
//          ，          
//           
if (condition) {
    //          ，             
    allowed();
}

다 중 주석
여러 줄 주석 은 줄 간 텍스트 를 감 싸 서 / * 로 시작 하여 * / 로 끝 낼 수 있 습 니 다.
【 예 시 】: 여러 줄 의 주석 은 크로스 텍스트 를 감 싸 는 데 만 사용 할 수 있 는 것 이 아니 라 당신 에 게 달 려 있 습 니 다.

/*      */
/*      
         */
/*
      
          
*/

[스타일]: 자바 스타일 의 여러 줄 주석.

/*
 *      
 *           
 */

【 설명 】: 적어도 세 줄, 첫 번 째 행동 / * 을 포함 하고 두 번 째 줄 은 * 로 시작 하고 이전 줄 의 * 와 왼쪽 정렬 을 유지 하 며 마지막 행동 * / 그리고 별표 와 그 후의 주석 설명 문자 의 간격 은 빈 칸 입 니 다.
[사용 방법]: 설명 할 코드 세그먼트 에 항상 나타 나 기 전에 주석 과 코드 사이 에 빈 줄 간격 이 없습니다.한 줄 주석 과 마찬가지 로 여러 줄 주석 전에 빈 줄 이 있어 야 하 며, 들 여 쓰기 단계 와 설명 한 코드 가 일치 해 야 합 니 다.
[예시]:

//     
if (condition) {
    
    /*
     *          
     *              
     */
    allowed();
}

//      ：       
if (condition) {
    /*
     *          
     *              
     */
    allowed();
}

//      ：       
if (condition) {

    /*
     *         
     *             
     */
    allowed();
}

//      ：     
if (condition) {

/*
 *          
 *              
 */
    allowed();
}

//      ：               
var result = something + somethingElse; /* somethingElse        null */

주석 사용
코드 가 명확 하지 않 을 때 주석 을 추가 하고 코드 가 명확 할 때 주석 을 추가 해 서 는 안 된다 는 것 이 통행 의 지도 원칙 이다.
[일반 원칙]: 코드 를 선명 하 게 해 야 할 때 주석 을 추가 합 니 다.
이해 하기 어 려 운 코드
이해 하기 어 려 운 코드 는 일반적으로 주석 을 추가 해 야 한다.코드 의 용도 에 따라 한 줄 주석, 여러 줄 주석 을 사용 하거나 이 두 가지 주석 을 혼용 할 수 있 습 니 다.문 제 는 다른 사람들 이 이 코드 를 쉽게 읽 을 수 있 도록 하 는 것 이다.
잘못된 코드 로 오 인 될 수 있 습 니 다.
코드 가 잘못 되 어 보일 때 다른 개발 자 들 이 호의 적 으로 '복구' 를 하지 않도록 설명 을 써 야 합 니 다.
브 라 우 저 기능 hack
JavaScript 프로그래머 들 은 저급 브 라 우 저 를 정상적으로 작 동 시 키 기 위해 비효 율 적 이 고 고상 하지 않 으 며 철두철미 한 더러 운 코드 를 자주 작성 합 니 다.실제 이러한 상황 은 특수 한 '오류 로 오 인 될 수 있 는 코드' 입 니 다. 브 라 우 저 특성 이 뚜렷 하지 않 은 Hack 코드 는 일부 오 류 를 포함 할 수 있 습 니 다.
문서 설명
기술적 인 측면 에서 볼 때 문서 주석 은 자 바스 크 립 트 의 구성 부분 이 아니 지만 보편적 인 실천 이다.
[스타일]: 자바 독 문서 형식 입 니 다.
【 형식 】: 여러 줄 주석 은 단사 선 에 쌍성 호 (/ * *) 를 추가 하여 시작 합 니 다. 다음은 정 보 를 설명 하 는 것 입 니 다. 그 중에서 @ 기 호 를 사용 하여 하나 이상 의 속성 을 표시 합 니 다.
[예시]:

/**
 ........
 @method merge
 @param {Object}            
 @return {Object}           
 **/

[주의]: 주석 의 상세 한 형식 과 용법 은 결국 당신 이 선택 한 문서 생 성 도구 에 의 해 결 정 됩 니 다.
[주석 추가 가 필요 한 내용]:
4. 567917. 모든 방법: 방법, 기대 하 는 매개 변수 와 가능 한 반환 값 에 주석 설명 을 추가 해 야 합 니 다
4. 567917. 모든 구조 함수: 사용자 정의 형식 과 원 하 는 매개 변수 에 주석 설명 을 추가 해 야 합 니 다
4. 567917. 모든 문서 화 방법 을 포함 하 는 대상: 한 대상 이 하나 이상 의 문서 주석 을 포함 하 는 방법 을 포함한다 면 이 대상 도 문서 생 성 도구 에 문서 주석 을 적당 하 게 추가 해 야 합 니 다