9
그래서 Javadoc 스타일의 문서화에 다소 익숙해졌습니다. 파이썬 코드의 다양한 예제를 통해 살펴보면, 처음에는 홍당무로 문서 이 많은 정보가 누락 될 수 있다고 생각합니다.Javadoc에서 Python 문서로의 마이그레이션
좋은 점은 드문 경우지만 문서의 자명 한 비트가 보이지는 않습니다. 문서 구조는 일반적으로 별도의 줄에서는 대신 통합되는 단락 또는 그 이하의 영어 마크 업입니다.
나쁘다 : 파이썬의 오리 타이핑과 관련하여 많은 기능들이 예상되는 매개 변수에 대해 명확하지 않다는 것을 발견했다. 타입 힌팅 (duck-hinting?)이 없으며, 매개 변수가리스트와 같은 문자열 (stream-like)이어야한다는 아이디어를 얻는 것이 좋을 때가 있습니다.
물론 Javadoc은 저급 언어 용으로 설계되었으며 Python의 뛰어난 내성 능력이 없기 때문에 설명서의 철저한 설명 철학을 설명 할 수 있습니다.
파이썬 설명서 표준 및 모범 사례에 대한 조언이 있으십니까?
무엇이 문제입니까? –
일종의 개방형입니다. 나는 조언을 찾고 있다고 덧붙였다. – Koobz
무엇에 대한 조언? 소프트웨어를 작성하고 문서를 제공하고 싶습니까? 또는 파이썬 라이브러리 설명서에서 물건을 찾을 수 없다는 불평을하십니까? "파이썬 ... 문서에 많은 정보가 누락 된 것 같습니다."라는 불만이 있습니다. 너 뭐하는 데 문제가 있니? –