파이썬 코딩 표준 05- 기본 사양 - 문서 문자열 (문서화 문자열)

문서화 문자열 사양 기본 포인트 :

(1) 모든 공용 모듈, 기능, 클래스, 메소드는 참조 문을 작성한다. 개인 방법은 반드시 필요하지 않습니다,하지만 데프 후에 설명하기 위해 블록 주석을 제공해야한다.

2, 끝을 문서화 문자열. "" "이 하나의 라인을 문서화 문자열하지 않는 한 별도의 줄에 있어야합니다.

"" " 돌려는 foobar 
옵션 plotz 먼저 bizbaz을 frobnicate 말한다. 
" "" 

"" " Oneline 문서화 문자열 " ""

 

추천

출처www.cnblogs.com/mazhiyong/p/12504751.html