epydoc 일부 클래스 함수 숨기기?

Question

클래스의 다른 메서드에서 사용하기위한 메서드가 일부 있습니다. 나는 그들의 이름 앞에 '_'을 붙였다. epydoc에서 그 기능을 숨길 수 있습니까? 좋은 생각입니까?

'_'또는 밑줄을 사용해야합니까? 솔직히 나는 어떤 곳에서 그들에 대해 읽은 후에 차이를 얻지 못했다. 이 명명 규칙을 모듈/클래스 (인스턴스) 함수에서만 사용해야합니까? 아니면 변수?

Answer 1

모든 개인적인 방법과 개인 변수를 숨기려면, '--no-private'옵션을 epydoc에 전달하십시오.

것을

주 - epydoc에 대한 -하는 방법이나 변수가 개인 인 경우 :

• 이름에 밑줄 '_'로 시작 및
• 밑줄로 끝나지 않는 이름 '_' 및
• 모두 사전에 이름을 포함시키지 않았습니다.

또는 '문서화되지 않은'태그를 사용하여 epydoc이 특정 메소드 나 변수를 완전히 무시하도록 할 수 있습니다.

예를 들어

(그리고 나는 여기 형식의 구조 조정 텍스트 종류 가정) : (당신이 '--no-개인'옵션을 사용하지 않은 경우)

class MyClass: 
    """Some neat description 

    :undocumented: x 
    """ 

    def _y(self): pass 
    def x(self): pass 
    def z(self): pass 

만 _y를 포함하는 문서가 발생합니다 및 지. 비록 그것이 사적이 아니더라도 x에 관해서는 아무 것도 없을 것입니다.

개인 문서가 최종 문서에서 전혀 보이지 않거나 보이지 않아야하는지 여부는 중요합니다. 내게는 내부 구현에 관심이 없거나 관심이없는 사람들이 문서를 읽습니다. 개인적인 방법은 숨겨진 것이 가장 좋습니다.