Perl에 대한 포드 댓글 작성에 대한 규칙이 있습니까?

Question

온라인으로 Safari Books에서 페이지를 찾을 수있었습니다. 템플릿, 그러나 포드 댓글을 작성한 적이 없지만, 그것이 얼마나 좋은지 또는 포함 할 협약으로 간주 될 수있는 내용이 누락되어 있는지 잘 모르겠습니다.

PERL 스크립트에 대한 포드 주석을 쓸 때 따라야 할 규칙은 무엇입니까? 같은 것이 있습니까? Sun의 Javadoc 협약, 그러나 포드 댓글을 위해?

Answer 1

정교하지는 않지만 나는 Juerd 's를 좋아합니다 Perlpodtut 소개 많은.

저자는 그가 공통 섹션을 고려하는 것과 그들이 포함 할 내용을 언급합니다.

Answer 2

권장 사항이 있습니다 Perl 모범 사례. 7 장 전체에는 문서, POD 사용 및 모듈, 대규모 프로젝트에 대한 문서화에 대한 최상의 접근 방식이 포함됩니다. 또한 CPAN 협약에 대해서도 설명합니다. 아마도 당신의 최선의 방법 일 것입니다.

Answer 3

Perl :: 비평가 다음 정책을 제공합니다.

• Perl :: 비평가 :: 정책 :: 문서 :: podsprelling

• Perl :: 비평가 :: 정책 :: 문서 :: 요구 사항 -epackagematchespodname

• Perl :: 비평가 :: 정책 :: 문서 :: 요구 사항

• Perl :: 비평가 :: 정책 :: 문서 :: 요구 사항

필요한 섹션 목록 위의 마지막 정책에 의해 제공됩니다.

모듈 :: 스타터 :: PBP 보일러 플레이트 코드를 생성합니다.

Answer 4

Perl 모듈의 포드를 볼 수 있습니다. CPAN 검색 그리고 모두가하는 일을 빨리 주목하십시오. 다양한 모듈 시작 도구는 보일러 플레이트를 만듭니다.

그것은 당신이 가이드 라인에 도달 할만큼 가깝습니다.