주석으로 가독성 향상
좋은 의견을 작성하는 열쇠는 코드의 가독성을 향상시키기 위해 "수행 된 일"이 아니라 "왜"를 설명하는 것입니다. 1. 의견은 가치 선택 또는 처리의 고려 사항과 같은 논리적 이유를 설명해야합니다. 2. 복잡한 논리에 대한 단락 주석을 사용하여 함수 또는 알고리즘의 전반적인 아이디어를 요약합니다. 3. 코드와의 일관성을 보장하고, 오해의 소지를 피하고, 필요한 경우 구식 콘텐츠를 삭제하기 위해 정기적으로 의견을 유지하십시오. 4. 코드를 검토 할 때 주석을 동시에 확인하고 문서를 통해 공개 논리를 기록하여 코드 주석의 부담을 줄입니다.
코드가 아무리 잘 작성 되더라도 아무도 이해할 수 없다면 쓸모가 없을 것입니다. 의견을 쓰는 것은 불필요한 움직임이 아니라 다른 사람들 (미래 자아 포함)이 아이디어를 더 빨리 이해할 수 있도록 허용합니다. 특히 여러 사람이 협력하거나 장기 유지 보수를하는 프로젝트에서 주석이 가독성을 향상시키는 가장 직접적인 방법입니다.

의견은 "무엇을했는지"가 아니라 "왜"를 설명해야합니다.
다음과 같은 코드를 습관적으로 반복하는 댓글을 쓸 때 많은 사람들이하는 일은 무엇입니까?
# 변수 x를 5로 설정합니다 x = 5
이런 종류의 의견은 실제로 쓸모가 없습니다. 실제로 유용한 것은이 값을 선택한 이유 또는 이런 방식으로 처리하는 이유와 같은이 코드의 논리를 설명하는 것입니다.

예를 들어:
# 최소 입력이 5이기 때문에 5를 기본값으로 사용합니다. x = 5
이런 식으로 읽는 사람들은 이것이 부담없이 쓰여지지 않았지만 구체적인 이유가 있다는 것을 알게 될 것입니다. 당신이 한 일을 말하지 말고 왜 그렇게했는지 분명히하십시오.

복잡한 논리에 단락 댓글을 추가하십시오
일부 기능이나 알고리즘에는 많은 논리가 있으며 코드를 직접 볼 때 혼동하기 쉽습니다. 이때, 당신은 처음에 짧은 설명을 작성하여 전반적인 아이디어를 명확하게 설명 할 수 있습니다.
예를 들어, 데이터 청소를 다루는 코드는 다음과 같습니다.
# 데이터 청소 단계 : # 1. 이상치 제거 (표준 편차의 3 배를 초과하는 값) # 2. 결 측값# 3에 앞으로 패딩을 사용하십시오. 범주 형 변수를 일대일 인코딩 def clean_data (df)로 변환합니다. ...
이런 식으로, 누군가는이 코드의 일반적인 프로세스를 스캔하여 알 수 있으며, 하나씩 추측 할 필요가 없습니다. 특히 방금 인수 한 사람들에게는이 구조화 된 주석은 매우 친절합니다.
메모는 정기적으로 유지되어야하므로 오해의 소지가되지 않도록하십시오.
많은 사람들이 더 이상 코드를 작성한 후에 댓글에 관심이 없습니다. 결과적으로 코드는 여러 라운드에 대해 변경되었으며 주석은 여전히 동일합니다. 이 상황은 다른 사람들을 오도 할 수 있기 때문에 의견을 쓰지 않는 것보다 더 나쁩니다.
단순히 문구를 조정하는 경우에도 주요 논리를 수정할 때 주석을 업데이트하는 것이 좋습니다. 주석이 더 이상 코드와 일치하지 않는다는 것을 알게되면 망설이지 마십시오. 오도하는 것보다 삭제하는 것이 좋습니다.
또한 주석의 품질을 유지하기 위해 다음과 같은 관행을 고려하십시오.
- PR을 검토 할 때 관련 댓글을 업데이트 해야하는지 확인하십시오.
- 문서 나 위키에 공개 논리를 기록하고 코드 주석을 사용하여 복잡한 논리를 설명하십시오.
-
# TODO: 这个地方需要优化
하지만 변경되지 않은 명백히 구식적이고 의미없는 의견을 삭제합니다.
기본적으로 그게 다야. 메모는 원하는만큼 작성되지 않고 정확하고 명확하게 작성해야합니다. 잘 사용하면 코드의 명령 매뉴얼입니다. 제대로 사용하면 노이즈가됩니다.
위 내용은 주석으로 가독성 향상의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

핫 AI 도구

Undress AI Tool
무료로 이미지를 벗다

Undresser.AI Undress
사실적인 누드 사진을 만들기 위한 AI 기반 앱

AI Clothes Remover
사진에서 옷을 제거하는 온라인 AI 도구입니다.

Clothoff.io
AI 옷 제거제

Video Face Swap
완전히 무료인 AI 얼굴 교환 도구를 사용하여 모든 비디오의 얼굴을 쉽게 바꾸세요!

인기 기사

뜨거운 도구

메모장++7.3.1
사용하기 쉬운 무료 코드 편집기

SublimeText3 중국어 버전
중국어 버전, 사용하기 매우 쉽습니다.

스튜디오 13.0.1 보내기
강력한 PHP 통합 개발 환경

드림위버 CS6
시각적 웹 개발 도구

SublimeText3 Mac 버전
신 수준의 코드 편집 소프트웨어(SublimeText3)

TheObserverdesignpatternenablesautomaticnotificationofdependentobjectswhenasubject'sstatechanges.1)Itdefinesaone-to-manydependencybetweenobjects;2)Thesubjectmaintainsalistofobserversandnotifiesthemviaacommoninterface;3)Observersimplementanupdatemetho

repay yourApplicationBenorgradletobuildajarorwarfile, 외부화 공기

로그백 또는 log4J2와 결합 된 SLF4J를 사용하는 것은 Java 응용 프로그램에서 로그를 구성하는 권장 방법입니다. 해당 Maven 의존성을 추가하여 API 및 구현 라이브러리를 소개합니다. 2. 코드에서 SLF4J의 LoggerFactory를 통해 로거를 가져오고 매개 변수화 된 로깅 방법을 사용하여 분리되고 효율적인 로그 코드를 작성하십시오. 3. 로그 출력 형식, 레벨, 대상 (콘솔, 파일) 및 패키지 레벨 로그 컨트롤을 logback.xml 또는 log4j2.xml 구성 파일을 정의합니다. 4. 선택적으로 구성 파일 스캔 기능을 활성화하여 로그 레벨의 동적 조정을 달성하고 SpringBoot도 액추에이터 엔드 포인트를 통해 관리 할 수도 있습니다. 5. 모범 사례를 포함하여

castorenablesxml-to-javaobjectmappingViAdventionSorxclationSpollicitMappingFiles; 1) definejavaclasseswithgetters/setters; 2) useUnmarshallertoconvertxmltoobjects; 3) USEMARSHALLERTOSERIAZEOBJECTSBACKTOXML;

$ _cookieisapppsuperglobalforaccessingcookiessentBythebrowser; cookiesAresetUsingSetCookie () preveroutput, readVia $ _cookie [ 'name'], values, anddeletedBySettanExpiredTimestamp, withSecurityBestFORTETTRATS, withSecurityBestPonly

PHP의 돌연변이 기능은 SPLAT 연산자 (...)를 통해 구현됩니다. 1. 함수 정의에서 함수 정의 (... $ 숫자)와 같은 매개 변수를 수집하여 전달 된 매개 변수를 배열로 집계합니다. 2. ADD (... [1,2,3])와 같은 함수를 호출 할 때 포장되지 않은 배열을 사용하여 배열 요소를 독립적 인 매개 변수로 전달하십시오. 이 연산자는 코드 가독성, 유형 안전 및 성능을 향상시키고 func_get_args ()와 같은 오래된 메소드를 대체하며 Summing, Logging 등과 같은 불확실한 매개 변수와 함께 시나리오에서 널리 사용됩니다.

@serverendpoint를 사용하여 경로를 정의하고 @onopen, @onmessage, @onclose 및 @onerror를 통해 연결, 메시지 수신, 닫기 및 오류를 처리하기 위해 WebSocket 서버 엔드 포인트를 작성하십시오. 2. 배포 중에 Javax.websocket-API 종속성이 도입되어 컨테이너에 의해 자동으로 등록되어 있는지 확인하십시오. 3. Java 클라이언트는 ContainerProvider를 통해 WebSocketContainer를 얻고 ConnectToServer를 호출하여 서버에 연결하고 @ClientendPoint 주석 클래스를 사용하여 메시지를 수신합니다. 4. 세션 getbasicre를 사용하십시오

theassertkeywordinjavaisubseedtovalidateassumptions developments.2
