thư viện dojo js + jsdoc -> cách ghi lại mã?

Question

Tôi rất muốn hỏi bạn làm thế nào để các chàng trai phát triển dojo tạo tài liệu?

Từ bản dựng hàng đêm, bạn có thể tải các tệp js không nén bằng tất cả các nhận xét và tôi chắc chắn có một số tập lệnh tạo tài liệu sẽ tạo ra một số html hoặc xml.

Tôi đoán họ sử dụng jsdoc vì điều này có thể được tìm thấy trong thư mục utils của họ, nhưng tôi không có ý tưởng về cách sử dụng nó. Bộ công cụ jsDoc sử dụng các ký hiệu khác nhau /**commenting**/ so với các tệp dojo gốc.

Cảm ơn sự giúp đỡ của bạn

Answer 1

Tất cả được thực hiện với trình phân tích cú pháp PHP tùy chỉnh và Drupal. Nếu bạn nhìn vào util/docscripts/README và util/jsdoc/INSTALL bạn có thể nhận được tất cả các chi tiết đẫm máu về cách tạo tài liệu.

Nó khác với jsdoc-toolkit hoặc JSDoc (như bạn đã khám phá).

FWIW, tôi đang sử dụng jsdoc-toolkit vì việc tạo HTML tĩnh dễ dàng hơn nhiều và có rất nhiều tài liệu về các thẻ trên trang mã google.

Ngoài ra, chỉ để rõ ràng, tôi không phát triển bản thân dojo. Tôi chỉ sử dụng nó rất nhiều trong công việc.

Answer 2

Có hai phần trong quy trình "dojo jsdoc". Có một trình phân tích cú pháp, được viết bằng PHP, tạo ra xml và/hoặc json của toàn bộ các không gian tên được liệt kê (được định nghĩa trong util/docscripts/modules, để bạn có thể thêm các không gian tên của riêng mình. php ") và một phần Drupal được gọi là" jsdoc "cài đặt như là một mô-đun/plugin/drupal bất cứ điều gì.

Khía cạnh Drupal của nó chỉ là chế độ xem cơ bản của Dojo về dữ liệu này. Một XSLT được chế tác tốt hay một thứ gì đó để lặp qua json và tạo ra html sẽ hoạt động giống nhau, mặc dù cả hai đều không được cung cấp theo mặc định (sẽ yêu một đóng góp!). Tôi né tránh bản thân Drupal, mặc dù nó đã chạy trên api.dojotoolkit.org một thời gian rồi.

Trình phân tích cú pháp doc được hiển thị để bạn có thể sử dụng khả năng kiểm tra của nó để viết đầu ra tùy chỉnh của riêng bạn. Tôi sử dụng nó để tạo ra mã hoàn thành Komodo .cix trong một tệp PHP [khá cẩu thả] util/docscripts/makeCix.php, nó kết xuất thông tin như được tìm thấy trong một tài liệu XML được tạo thủ công để khớp với thông số ở đó. Điều này có thể được sửa đổi để tạo ra bất kỳ loại đầu ra nào bạn đã chọn với một chút finagling.

Cú pháp doc được tất cả các định nghĩa trên trang hướng dẫn phong cách: http://dojotoolkit.org/reference-guide/developer/styleguide.html