주석 처리 된 함수와 "쉼표 스플 라이스"의 기능은 무엇입니까?

Question

저는 지난 2 주 동안 몇 비트의 코드를 해부했는데 몇 가지 주제가 반복해서 나타납니다 ... 예를 들어 다음과 같은 점은 무엇입니까?

class eventHandler(object): 
    def create_event(self, event): 
     """A general note here. 

     :tagged param event: 
      description 
     :tagged type event: 
      :class: `another class` # I do not understand the comma splices (`). 
     """ 
     # I do not understand why it ends here with no real purpose. Perhaps I'm not catching on to something. 

    def next_event(self, event): 
     ... 
     # Continues with the same logic from above 

것은 내가 파이썬 모듈 "감시"뿐만 아니라 인터넷에 흩어져있는 과거의 다른 모듈과 코드 조각에서 그것을 보았다. 메모 유지를위한 sudo-code 형식인가요? 기능이 중단 되었습니까? 나는 특히 뭔가를 이해하지 못하고 있는가?

편집 : Artagel 좋은 참조를 가져

, 내가 충분히 PEP-0008 깊은 읽을 수 있었다.

Answer 1

backquotes는 doc 문자열을 구문 분석하여 멋지게 형식화 된 문서를 생성하는 일종의 문서 생성기에 의미가있을 것입니다. 파이썬 언어 자체에는 의미가 없습니다.

create_event은 아마도 eventHandler의 하위 클래스로 구현하려는 방법 일 수 있습니다. 의사 문자열만으로도 구문법으로는 메서드의 본문으로 사용할 수 있습니다. 문서 문자열이 없으면 pass 문을 사용하여 "실제"본문의 자리 표시 자 역할을해야합니다.

def create_event(self, event): 
    pass