Định dạng tài liệu nhận xét nào tốt hơn cho JavaScript?

Question

Có bất kỳ định dạng tài liệu nhận xét nào cho JavaScript và bộ xử lý cho định dạng này tạo tài liệu HTML không?

Hiện tại tôi đang sử dụng nhận xét xml của VSDoc để cung cấp trợ giúp IntelliSense vào thời gian phát triển, nhưng như tôi biết không có trình tạo tài liệu nào cho các nhận xét như vậy. Vì vậy, cách khác câu hỏi của tôi có vẻ như: Có bất kỳ tiện ích nào dịch các nhận xét VSDoc từ các tệp JavaScript sang HTML không?

Answer 1

Bạn đã xem tài liệu được tạo tự động từ JavaDoc hoặc VSDoc hoặc JSDoc hay bất kỳ thứ gì tương tự.

Tất cả đều xấu và không thể đọc được.

Giải pháp là hai lần

• annotate your code with docco
• Hãy chắc tay tài liệu API của bạn bằng văn bản.

Có tùy chọn thứ ba để cách mạng hóa cách chúng tôi tạo tài liệu được tạo tự động, nếu bạn có thể làm như vậy.

Answer 2

Tôi đã sử dụng Natural Docs cho một vài dự án. Cú pháp là tốt đẹp để đọc nội tuyến, nhưng vì nó không có "hỗ trợ ngôn ngữ đầy đủ" cho JavaScript, bạn phải có phần nào rõ ràng về mỗi hàm/hằng số/lớp/bất cứ điều gì bạn muốn làm tài liệu.

Answer 3

Có một tiện ích phân tích các file javascript và kết quả đầu ra cùng NDoc định dạng XML và sử dụng Sandcastle: AjaxDoc

Bằng cách đó bạn sẽ có được IntelliSense VS từ các ý kiến ​​tương tự và có thể ra định dạng bất kỳ mà bạn muốn.