정말 좋은 문서가 필요한 API를 구축하고 있습니다. 수동으로 모든 문서를 작성할 수 있지만 필요한 것보다 많은 노력이 필요하다고 생각합니다. 일종의 웹 문서 프레임 워크 또는 도구로 Google에서 찾았지만 아무것도 찾을 수없는 것 같습니다.문서 프레임 워크가 필요합니다.
누군가 내 API 웹 사이트에서 사용법에 대한 참고 자료로 사용할 수있는 멋지고 전문적인 웹 문서 세트를 만들 수있는 도구 나 프레임 워크에 대해 알고 있습니까? 또한 작업의 전체적인 수행을 요구하지 않고 기존의 문서 페이지를 업데이트하거나 수정하는 것이 용이하다면 또한 좋을 것입니다.
편집 : 문서 자체의 구체적인 언어는별로 중요하지 않습니다. 지금은 조사 할 좋은 옵션이 필요합니다.
일반적으로 허용되는 방법은 주석을 사용하여 코드를 문서화 한 다음 그. PHP의 경우 PHPDoc이 있습니다. http://www.phpdoc.org/
음 ...이 부분을 살펴 보겠습니다. 찾고있는 유형인지는 확실하지 않지만 조사가 필요합니다. 감사. – paradox870
가능한 한 작은 일을하는 것이 가장 좋습니다. 추가 보너스는 당연히 귀하의 IDE가 그것을 선택할 수 있기 때문에 API를 사용할 때 설명서가 표시됩니다. – Nanne
예. REALLY REALLY 좋은 주석을 쓰면 웹 문서가 기본적으로 완성됩니다. 이 문제를 해결하기로 결정하면 답을 수락 하겠지만, 지금은 더 많은 옵션을 찾고 있습니다. – paradox870
선택의 언어에 따라,의 코드 문서 주석에서 문서 페이지를 생성 할 수있는 많은 도구 (C/C 예 : doxygen이 ++, Java 용의 javadoc)
반드시뿐만 아니라 문서의 클래스를 확인이 있습니다 메서드를 제공하지만 예제 사용법과 클래스가 무엇을해야하는지, 프레임 워크에서 어떻게 맞는지에 대한 설명은 중요하지 않습니다.
어떤 프로그래밍 언어가 있습니까? – mzjn
API는 PHP로 작성되었지만 문서 작성/작성 방법에 대해별로 신경 쓰지 않습니다. – paradox870