Python 함수에 대한 도움말/설명 텍스트 작성 방법

Question

최근에 Python을 사용하여 프로그래밍을 시작했습니다. 필자는 많은 함수를 작성해야하며 함수를 호출 할 때 스파이더의 개체 관리자에 도움말이나 설명 텍스트를 어떻게 포함시킬 수 있는지 궁금합니다. MatLab에서 이것은 주석 파일을 함수 파일의 시작 부분에 놓음으로써 가능했습니다. Pythong (Spyder 사용)과 비슷한 방법이 있습니까?

Answer 1

기본적으로 메서드 본문의 첫 번째 문자열은 해당 docstring (또는 설명서 문자열)로 사용됩니다. 파이썬은 help()이 호출 될 때 이것을 사용할 것입니다.

def foo(bar): 
    ''' Takes bar and does 
     some things to it ''' 
    return bar 

help(foo) 
foo(bar) 
    Takes bar and does 
    some things to it 

당신은이 PEP-258를 읽어 작동 방식에 대한 자세한 내용을보실 수 있습니다, 그리고 this question 좀 더 세부로 들어갑니다.

Answer 2

(여기 스파이더 dev에)를 사용하면 (Burhan입니다 - 칼리드 언급 무엇 @ 외에) 알아야 할 것들을 다른 몇 가지가 있습니다 스파이더 자체에 관한 :

1. 당신이 정중하게 서식하여 문서화 문자열을보고 싶다면 Object Inspector에서 numpydoc 표준 (here)으로 작성해야합니다. 이것은 거의 모든 파이썬 과학 패키지가 docstring을 작성하는 데 사용하는 규칙 세트입니다. 필수는 아니지만 docstrings (일반 텍스트로 제공)을 html로 변환하는 중에도이를 수행합니다.

2. 당신은 오브젝트 인스펙터에서 그들의 도움을 표시하는 객체의 이름 앞에 Ctrl 키 I + 을 사용해야합니다.