Tạo tài liệu Javascript

Question

Im đang tìm kiếm tài liệu về mã javascript mà chúng tôi phát triển và đang tìm kiếm một số trình tạo tài liệu javascript tốt, có ai có bất kỳ đề xuất nào không?

Chúng tôi đã sử dụng ndoc để tạo tài liệu cho mã C# của chúng tôi và đang tìm kiếm một cái gì đó tương tự như tài liệu mã js của chúng tôi - lý tưởng một cái gì đó có thể được chạy từ một dòng lệnh.

cảm ơn trước!

Answer 1

Bạn có thể sử dụng JSDoc-Toolkit nổi tiếng cho điều đó.

JsDoc Toolkit là một ứng dụng, viết bằng JavaScript, cho tự động tạo mẫu định dạng, HTML nhiều trang (hoặc XML, JSON, hoặc bất kỳ dựa trên văn bản khác) tài liệu từ nhận xét mã nguồn JavaScript .

Và có nó cũng có command line options.

Answer 2

JSDoc là phương pháp tạo tài liệu từ JavaScript nhận xét. Có nhiều biến thể:

• Ban đầu nó được triển khai trong Perl.
• JSDoc-Toolkit chuyển nó sang JavaScript, nhưng yêu cầu Java vì nó sử dụng công cụ JavaScript Rhino được viết bằng Java.
• Một số người đã chuyển nó để chạy trực tiếp trên nền tảng/nền tảng JavaScript node.js, ví dụ: node-jsdoc-toolkit.
• dox cũng chạy trên node.js, nó kết hợp các thẻ giống như JSDoc và đánh dấu markdown nhưng yêu cầu một công cụ tạo khuôn mẫu riêng biệt (như được sử dụng trên Stack Overflow và github).

Tất cả chạy từ dòng lệnh. Chọn theo tùy chọn công cụ của bạn. Tôi thích node.js cho tốc độ của nó và cảm giác tất cả-JavaScript-all-the-time. DailyJS "Hãy tạo một khung" post on writing documentation mô tả những công cụ này và các công cụ khác; tiếc là dox đã được đại tu hoàn toàn để chỉ xuất các cấu trúc JSON kể từ khi được viết.

https://stackoverflow.com/q/1221413/1162195 đề cập đến các trình tạo tài liệu JavaScript khác.