파이썬에서는 help("모듈 이름") 또는 help(클래스 이름)를 사용하여 클래스나 함수의 문서를 볼 수 있습니다. 그러나 그것들은 어떻게 쓰여졌습니까? 실제로 클래스나 메서드 시작 부분에 여러 줄의 주석을 묶기 위해 """ 세 개의 큰따옴표를 사용합니다. 이러한 내용은 Python에서 도움말 문서로 간주됩니다.
도움말 문서에는 일반적으로 어떤 내용이 포함되나요? 🎜>들어오는 값과 출력 값
일부 특수한 경우에 대한 지침
문서 테스트 내용
위 내용은 개인적인 요약이지만 관련 내용을 본 적이 없습니다.
예를 들어보겠습니다:
class Apple(object): """ This is an Apple Class""" def get_color(self): """ Get the Color of Apple. get_color(self) -> str """ return "red"
>>> from CallDemo import Apple >>> help(Apple) Help on class Apple in module CallDemo: class Apple(__builtin__.object) | This is an Apple Class | | Methods defined here: | | get_color(self) | Get the Color of Apple. | get_color(self) -> str | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined)
댓글에서 doctest 모듈을 사용할 수도 있습니다. >
예를 들어 문서 테스트 콘텐츠를 추가하면 다음과 같습니다:
class Apple(object): """ This is an Apple Class Example: >>> apple = Apple() >>> apple.get_color() 'red' >>> apple.set_count(20) >>> apple.get_count() 400 """ def get_color(self): """ Get the Color of Apple. get_color(self) -> str """ return "red" def set_count(self, count): self._count = count def get_count(self): return self._count * self._countif __name__ == '__main__': import doctest
doctest.testmod()
if __name__ == '__main__': import doctest doctest.testmod()
라고 작성했으므로 위의 문서 테스트는 엔트리 파일로 실행할 때만 수행되므로 실제 응용 프로그램에서는 문서 테스트가 수행되지 않습니다. 위는 Python 학습 노트 - 도움말 문서 작성입니다. 커스텀 클래스나 함수, 문서 테스팅에 대해서는 PHP 중국어 홈페이지(m.sbmmt.com)를 참고해주세요.