2014-10-14 8 views
0

pydoc을 사용하여 문서를 만듭니다. 그러나 __init__과 같은 클래스 및 방법에 대해서만 docstring이 표시됩니다. pydoc에 전달할 매개 변수가 있습니까? 각 메서드 클래스에 대한 설명서도 만들 수 있습니까?클래스의 일부 문서화 문자열이 pydoc에 표시되지 않는 이유는 무엇입니까?

예 : ".이 MyMethod라는 기능에 대한 문서화 문자열은"

class myclass(some_other_class): 
    """ 
    This is 'class' docstring. 
    """ 

    def __init__(self): 
     """ 
     This is docsctring for __init__ method. 
     """ 
     pass 

    def mymethod(self, some_parameter): 
     """ 
     This is docstring for mymethod function. 
     """ 
     pass 
이제

이 코드에 pydoc이를 사용할 때, 내가 볼 수 없습니다 생성 된 출력에서.

+2

예제 코드하십시오 : 그것은 다음과 같은 HTML을 생성? –

+1

인스턴스 메서드, 클래스 메서드, 정적 메서드? 선행 밑줄 메소드 이름? 어떤 데코레이터가 관련 되었습니까? – jonrsharpe

+0

예. 인스턴스 메소드, 클래스 메소드, leading_underscore 메소드 및 데코레이터도 있습니다. – Sangram

답변

1

코드가 완벽하게 잘 보입니다. script.py 파일에 넣고 "some_other_class"참조를 삭제하고 python -m pydoc -w script을 실행했습니다.

class myclass 
     This is 'class' docstring. 

     Methods defined here: 
      __init__(self) 
      This is docsctring for __init__ method. 
      mymethod(self, some_parameter) 
      This is docstring for mymethod function.