2013-09-24 2 views
3

중첩 된 함수에 대한 설명서를 생성하는 방법을 찾고 있습니다.이 경우에는 pydoc을 사용합니다. 이것이 pydoc에서 가능합니까? 다른 도구로도 가능합니까? 예를 들어중첩 된 함수에 대해 pydoc을 생성하는 방법이 있습니까?

:

""" 
Module docstring. 
""" 

def foo(x): 
    """ 
    Foo does something. 
    """ 
    ... 

    def bar(y): 
     """ 
     Bar does something 
     """ 
     ... 

와 pydoc이 생성 : -filename-이 아닌 막대의 모듈과 foo는()에 대한 pydoc이 생성됩니다 -w pydoc이을().

일반적으로 괜찮습니다. 문제는 내가 교육적 목적으로 라이브러리를 만들고, 클로저 내부에서 일어나는 일을 문서화하는 것이 특별히 도움이된다는 것입니다. 내부 기능을 전역 범위에 노출시키지 않고 문서화하는 방법을 찾고 싶습니다.

""" 
Module docstring. 
""" 

def foo(x): 
    """ 
    Foo does something. 
    N.B. Foo includes a local function bar() that does what bar does. 
    """ 
    ... 

    def bar(y): 
     """ 
     Bar does something 
     """ 
     ... 

그것은 자동 아니지만 당신의 학생들 만이 볼을하고자하는 개인 방법에 대한 설명서를 참조 할 수 있음을 의미 하는가 :

답변

0

는 항상 수동 방법이있다.

관련 문제