epydoc에서 함수의 변수에 대한 문서화

Question

epydoc을 사용하여 함수에 정의 된 인스턴스 변수를 문서화하는 방법. 나는 다음을 사용했지만 생성 된 HTML 문서의 변수 섹션에만 __package__ = None이 표시됩니다.

def fun() 
    x = 22 #: Document defining the purpose of x 

이는 EpyDoc 웹 사이트에 지정됩니다

변수는 주석 문서화 문자열을 사용하여 문서화 할 수있다. 변수 대입에 특수 마커 '# :'로 시작하는 줄이있는 주석이 바로 앞에 오거나 그 줄에 같은 주석이 올 경우 해당 변수에 대한 문서화 문자열로 처리됩니다.

#: docstring for x 
x = 22 
x = 22 #: docstring for x 

Answer 1

할 수 없거나 할 수 없습니다. Epydoc 및 유사한 도구는 API 문서, 즉 함수 (클래스, ...)를 사용하는 사람들을위한 문서를 만드는 데 사용됩니다. 함수를 사용하는 경우, 공용 인터페이스의 일부가 아닌 함수의 로컬 이름이 무엇인지는 중요하지 않습니다. 인터페이스는 인수와 반환 값입니다. 실제 구현은 블랙 박스이며 함수가 문서에서 약속하는 바를 수행하는 한 교환 가능해야합니다.