자체 문서화 자바 스크립트를 작성하는 15 가지 방법

자체 문서화 된 JavaScript 코드를 작성하기위한 핵심 사항

이 기사는 구조화 된 기술, 이름 지정 규칙 및 구문 기술을 통해 자체 문서화 및 유지 관리자 자체 문서화 된 JavaScript 코드를 작성하는 방법을 살펴 봅니다. 자체 문서화 코드는 의견의 필요성을 줄일 수 있지만 좋은 의견과 포괄적 인 문서를 완전히 대체하지는 않습니다. 핵심 기술

구조화 된 기술 : 코드를 함수로 이동하고 조건부 표현식을 함수로 바꾸고 순수한 기능을 사용하여 코드를 더 명확하고 이해하기 쉽게 만듭니다. 이름 지정 컨벤션 : 이름 변수, 기능 및 의미있는 이름을 가진 클래스.

구문 기술 :

구문 기술 사용을 피하고 명명 된 상수를 사용하고 코드를 더 명확하게하십시오.
• 주의를 기울여 코드 추출 : 짧은 기능을 추구 할 때 과도한 추출 코드를 피하면 코드의 이해가 줄어 듭니다.
• 기술적 개요 우리는 자체 문서화 코드를 세 가지 범주로 나눕니다
구조 :
• 코드 또는 디렉토리의 구조를 사용하여 코드의 목적을 명확히하십시오. 이름 관련 : 예를 들어, 함수 또는 변수의 이름.
구문 관련 : 언어 기능을 사용하거나 피하기 위해 코드를 명확하게합니다.
• 구조화 된 기술

코드를 기능으로 이동 : 기존 코드를 새로운 함수로 이동하여 함수를 명확하게 만듭니다. 예를 들어, 는 다음과 같이 다시 쓸 수 있습니다

조건 표현식을 함수로 바꾸십시오.

복잡한 조건 문을 기능으로 변환하여 가독성을 향상시킵니다.
표현식을 변수로 바꾸십시오 :
• 복잡한 표현식을 여러 변수로 분해하여 이해력을 향상시킵니다.
클래스 및 모듈 인터페이스 :
• 클래스의 공개 방법과 속성은 사용법 문서로 사용할 수 있습니다. 명확한 인터페이스는 클래스 사용을 직접 반영 할 수 있습니다.
코드 그룹화 :

관련 코드 그룹은 코드 사이에 연관성이 있고 유지 보수를 용이하게 함을 나타냅니다.

순수 함수 사용 :

순수 함수는 출력이 입력 매개 변수에만 의존하고 부작용이 없기 때문에 이해하기 쉽습니다.
• 디렉토리 및 파일 구조 : var width = (value - 0.5) * 16; 코드 검색 및 이해를 용이하게하기 위해 프로젝트의 기존 이름 지정 규칙에 따라 파일 및 디렉토리를 구성합니다.

var width = emToPixels(value);

function emToPixels(ems) {
    return (ems - 0.5) * 16;
}

이름 지정 기술

• 함수 이름 바꾸기 : 동사를 활성 음성으로 사용하고 반환 값을 명시 적으로 표시합니다. "핸들"또는 "관리"와 같은 모호한 단어를 사용하지 마십시오.

변수 Rename :
• 의미있는 이름을 사용하고 장치를 지정하십시오 (예 : ). 약어 사용을 피하십시오.

• 확립 된 명명 규칙을 준수합니다.

  프로젝트에서 일관된 이름 지정 스타일을 유지하십시오.

  의미있는 오류 메시지 사용 :
코드에서 발생한 오류 메시지가 설명적이고 오류를 일으킨 관련 정보가 포함되어 있는지 확인하십시오.

• 문법 기술

문법 팁 사용을 피하십시오 : 와 같은 이해하기 어려운 문법 팁을 사용하지 않고 명확한 문을 사용하십시오.

마법 값을 피하기 위해 이름이 지정된 상수를 사용하십시오.
• 마법 값 대신 이름이 상수를 사용하여 코드 가독성과 유지 관리 가능성을 향상시킵니다.

  imTricky && doMagic(); 부울 깃발을 피하십시오 : if 부울 플래그는 코드를 이해하기 어려울 수 있으며 더 명확한 접근 방식을 고려해야합니다.

• 언어 기능을 최대한 활용하십시오 :

  배열 반복 방법과 같은 언어가 제공하는 기능을 사용하여 코드를보다 간결하고 이해하기 쉽게 만듭니다.

  반 모드

• 짧은 함수에 대한 코드 과잉 추출 : 짧은 기능을 추구하기 위해 코드를 과도하게 추출하지 않으므로 코드의 이해력을 줄일 수 있습니다.

• 강제하지 마십시오 :

  메소드가 적합하지 않으면 사용하도록 강요하지 마십시오.

  요약

자체 문서화 코드를 작성하면 코드의 유지 관리 가능성을 크게 향상시키고 의견의 필요성을 줄일 수 있습니다. 그러나 자체 문서화 코드는 문서 나 의견을 완전히 대체 할 수 없습니다. 좋은 주석과 API 문서는 여전히 대규모 프로젝트에 중요합니다.

위 내용은 자체 문서화 자바 스크립트를 작성하는 15 가지 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!