도장을 개발하는 사람들이 어떻게 문서를 작성하는지 묻고 싶습니다.dojo js library + jsdoc -> 코드를 문서화하는 방법?
야간 빌드에서 모든 주석이있는 압축되지 않은 js 파일을 얻을 수 있으며 일부 html 또는 xml 파일을 생성하는 스크립트를 문서화하는 것이 좋습니다.
jsdoc은 utils 폴더에서 찾을 수 있지만 사용 방법은 모르겠다. jsDoc 툴킷은 원래 dojo 파일보다 다른 /**commenting**/ 표기법을 사용합니다.
덕분에 모든 당신의 도움
것은 모든 사용자 정의 PHP 파서와 드루팔로 이루어집니다. util/docscripts/README과 util/jsdoc/INSTALL을 보면 문서를 생성하는 방법에 대한 모든 세부 정보를 얻을 수 있습니다.
jsdoc-toolkit 또는 JSDoc (youv'e found)과 다릅니다.
FWIW, 정적 HTML을 생성하는 것이 훨씬 쉽고 Google 코드 페이지의 태그에 대한 많은 문서가 있으므로 FWIW는 jsdoc-toolkit을 사용하고 있습니다.
또한 분명히하기 위해 도장 자체를 개발하지 않습니다. 나는 직장에서 많이 사용합니다.
"dojo jsdoc"프로세스에는 두 부분이 있습니다. PHP로 작성된 구문 분석기 (parser)는 나열된 네임 스페이스 전체 (xml 및/또는 json을 생성 함) (util/docscripts/modules에 정의되어 있으므로 고유 한 네임 스페이스를 추가 할 수 있습니다.) "generate"파일의 기본 사용법이 있습니다. php ")와 drupal 모듈/플러그인/무엇이든간에 설치하는"jsdoc "이라는 Drupal 부분이 있습니다.
Drupal 측면은이 데이터에 대한 Dojo의 기본보기입니다. 잘 만들어진 XSLT 또는 json을 반복하고 html을 생성하는 것은 똑같이 작동 할 것입니다.하지만 기본적으로 제공되는 것은 아니지만 (공헌을 좋아할 것입니다!). 나는 api.dojotoolkit.org에서 얼마 동안 실행되어 왔지만 드루팔 (Drupal) 비트를 직접 부끄러워합니다.
doc 파서가 노출되어 있으므로 사용자가 자체 검사 출력을 작성하는 데 검사 기능을 사용할 수 있습니다. 필자는 Komodo .cix 코드 완성을 PHP 파일 인 util/docscripts/makeCix.php에서 생성합니다. util/docscripts/makeCix.php는 거기에 맞는 XML 문서로 정보를 덤프합니다. 이것은 약간의 결말로 선택한 출력을 생성하도록 수정 될 수 있습니다.
기타 문서 구문
모든 스타일 가이드 라인 페이지에 정의됩니다 http://dojotoolkit.org/reference-guide/developer/styleguide.html
사실. 나는 jsdoc 방식으로 갔다. 짧은 설명 주셔서 감사합니다! – belzebu