Làm cách nào để xem tài liệu được tạo bằng mã hóa trong Visual Studio Code?

Question

Tôi đã xây dựng dự án Angular 2/Typescript trong Visual Studio Code và thêm các khối chú thích JSDoc một cách chắc chắn, nhưng bây giờ tôi muốn xem kết quả JSDoc. Tôi có thể cài đặt và thiết lập hệ thống tạo JSDoc của riêng tôi, nhưng với tất cả sự hỗ trợ GUI đẹp trong VSC, có vẻ hợp lý để có thể tạo và xem quyền JSDoc từ VSC.

Google-Fu của tôi đã không hoạt động; mỗi khi tôi tìm kiếm "Tạo đầu ra JSDoc trong Visual Studio Code", tôi chỉ nhận được các plugin để tạo các khối bình luận JSDoc.

Có phương pháp tạo và xem đầu ra JSDoc trong Visual Studio Code không?

Answer 1

AFAIK không có xây dựng trong hỗ trợ, nhưng tôi không nghĩ rằng đó là cần thiết, như bạn có thể dễ dàng thêm một nhiệm vụ mà có thể chạy lệnh jsdoc thích hợp. Tôi không biết nếu điều này là những gì bạn có nghĩa là bởi "thiết lập hệ thống thế hệ JSDoc của riêng bạn", nhưng nó được thực hiện một cách nhanh chóng:

1. Đầu tiên cài đặt các máy phát điện jsdoc từ nhà ga: npm install -g jsdoc (giả sử bạn có Node.js/npm).
2. Quyết định lập luận bạn cần cho jsdoc (xem http://usejsdoc.org/about-commandline.html)
3. Thiết lập một nhiệm vụ (ví dụ như từ menu: Nhiệm vụ -> Configure Nhiệm vụ) - xem https://code.visualstudio.com/Docs/editor/tasks để biết thêm (thậm chí bạn có thể thêm một phím tắt)
4. Mở trang html được tạo bằng JSDocs của bạn.

Answer 2

Nơi tôi đã tìm thấy các jsdocs hữu ích trong vscode là dành cho intellisense.

Nói rằng tôi có chức năng này

/** 
* This squares a function 
* @param x takes this value and doubles it 
*/ 
function myAwesomeFunction(x: number) { 
    return x *x; 
} 

Sau đó vscode sẽ chỉ cho tôi jsdocs mô tả này bất cứ khi nào tôi cố gắng và gọi hàm.