python docstring 예제

일관성을 위해 항상 docstrings 주위에 “”"”"트리플 더블 따옴표”를 사용합니다. 당신이 당신의 문서 문자열에 백슬래시를 사용하는 경우 r”"”원시 트리플 더블 따옴표 “”"”를 사용합니다. 유니코드 문서 문자열의 경우 u”"”"유니코드 삼중 인용 문자열”"”을 사용합니다. 클래스와 그 메서드에 대한 문서 문자열을 작성하는 방법을 보여 드리겠습니다. 도움말은 문서 문자열에 액세스하는 데 사용됩니다. “사양”텍스트는 주로 귀도 반 로섬의 파이썬 스타일 가이드 [4] 에세이에서 그대로 제공됩니다. 클래스가 다른 클래스를 하위 클래스로 분류하고 해당 동작이 대부분 해당 클래스에서 상속되는 경우 해당 docstring은 이를 언급하고 차이점을 요약해야 합니다. 동사 “재정의”를 사용하여 하위 클래스 메서드가 수퍼 클래스 메서드를 대체하고 수퍼 클래스 메서드를 호출하지 않음을 나타냅니다. 동사 “extend”를 사용하여 하위 클래스 메서드가 자체 동작 외에 수퍼 클래스 메서드를 호출함을 나타냅니다. 결국 코드를 문서화하는 데 필요한 작업량에 실망하거나 압도당하지 마십시오.

코드 문서화를 시작하면 계속 진행하기가 더 쉬워집니다. 질문이 있거나 소셜 미디어에서 실제 파이썬 팀에 연락하면 자유롭게 의견을 제시할 수 있으며, 저희가 도와드리겠습니다. 개인 프로젝트는 개인적으로 사용자를 위한 것이지만 사용자로 간주됩니다. 길을 따라 당신에게 혼란 스러울 수있는 것에 대해 생각하고 의견, 문서 문자열 또는 readme에서 그 를 캡처해야합니다. docstring은 모듈, 함수, 클래스 또는 메서드 정의의 첫 번째 문으로 발생하는 문자열 리터럴입니다. 이러한 문서 문자열은 해당 개체의 __doc___ 특수 속성이 됩니다. 다니엘레 프로치다 (Daniele Procida)는 파이썬 프로젝트 문서화에 대한 멋진 PyCon 2017 강연과 후속 블로그 게시물을 제공했습니다. 그는 모든 프로젝트에 작업을 집중할 수 있도록 다음 네 가지 주요 섹션이 있어야 한다고 언급했습니다.

이렇게 하면 Emacs의 단락 채우기 명령을 사용할 수 있습니다. 파이썬 문서 문자열(또는 문서 문자열)은 문서를 Python 모듈, 함수, 클래스 및 메서드와 연결하는 편리한 방법을 제공합니다. 이러한 유형의 문서 문자열은 자기 성찰이 불가능한 C 함수(예: 기본 제공)에만 적합합니다. 그러나 반환 값의 특성은 자기 성찰에 의해 결정될 수 없으므로 언급해야 합니다. 이러한 docstring에 대 한 기본 형식은 다음과 같습니다: 다중 줄 docstrings 는 한 줄 의 docstring 처럼 요약 줄, 빈 줄 뒤에 더 정교한 설명으로 구성 됩니다. 요약 줄은 자동 인덱싱 도구에서 사용할 수 있습니다. 한 줄에 맞고 나머지 문서 문자열과 빈 줄로 구분하는 것이 중요합니다. 요약 줄은 여는 따옴표와 같은 줄에 있거나 다음 줄에 있을 수 있습니다. 전체 docstring은 첫 번째 줄의 따옴표와 동일하게 들여쓰기됩니다(아래 예제 참조).

패키지 문서 문자열은 패키지의 __init__py 파일 의 맨 위에 배치해야 합니다. 이 문서 문자열은 패키지에서 내보내는 모듈 및 하위 패키지를 나열해야 합니다. 모듈의 docstring은 일반적으로 모듈에서 내보내는 클래스, 예외 및 함수(및 기타 개체)를 각각의 한 줄 요약과 함께 나열해야 합니다.

Comments are closed.