2009-08-26 3 views
7

데이터베이스 패키지를 API로 더 완벽하게 문서화하려고합니다. 우리가 원하는 것은 PL/SQL 용 JavaDocs와 같은 것입니다. 필자는 몇 가지 도구 (pldoc, plsqldoc)를 보았지만 비교 방법을 사용하는 사람들로부터 알고 싶습니다.Pl/SQL 패키지 인라인 설명서

답변

6

나는 PlDoc을 사용해 정말 잘 찾았습니다. 나는 비교할 수없는 다른 도구를 사용하지 않았습니다. PlDoc이 기초를 잘 찾았습니다. 좀 더 고급 기능을 원했기 때문에 더 많은 태그를 위해 PlDoc에 확장 기능을 추가 한 자체 도구를 만들었습니다. 또한 필자는 그것과 함께 문서를 작성하지 않고 PlDoc 태그 (예 : @private)를 사용하여 패키지 헤더를 생성합니다.

PlDoc을 시도한 다음 필요에 맞게 조정하지 않는 것이 좋습니다. 너무 오랜 시간이 걸리지 않기 때문에 시간을 투자하지 않아도됩니다.

2

저는 수년 동안 NaturalDocs을 사용 해왔고 설치와 사용이 쉽습니다. JavaDocs와 매우 비슷하며 PL/SQL에서만 사용했지만 여러 언어를 지원합니다. 필자가 그걸 알아볼 필요가 없지만 구성이 가능합니다.

+0

나는이 특별한 도구를 당신의 대답없이 발견하지 못했을 것입니다. 꽤 접근하기 쉬운 반면, 우리 팀이 필요로하는 것은보다 엄격하게 구조화 된 솔루션이라고 생각합니다. 감사! –