JSdoc - Tạo documentation trực tiếp từ comments trong file JavaScript

TIL

781

@100daysTIL

72

Minh-Trung Nguyễn viết ngày 27/02/2018

JSdoc - Tạo documentation trực tiếp từ comments trong file JavaScript

Day 27

• JSDoc là 1 module giúp tạo project documentation từ comments trong các file JavaScript.
• Điều này có nghĩa là ông nào code, hiểu rõ code của mình nhất, thì trực tiếp viết docs cho chính code của ông ý đơn giản chỉ bằng các comments đặt ngay bên trên các module/ function.
• Tất nhiên các comments này phải tuân theo quy tắc chung, đưa ra bởi JSDoc, để JSDoc có thể hiểu và chuyển nó thành documentation.
• Có nhiều format cho documentation để người dùng lựa chọn, gọi là template. Documentation xuất ra có thể là dạng html hoặc markdown. Nhưng html có lẽ là định dạng chính.
• Để chạy được jsdoc, cần:
  • Cài jsdoc thông qua npm install --save
  • Sau đó, để tránh gõ command line dài dòng, thì thêm cấu hình trong package.json phần script.
  • Để truyền vào các tham số cho jsdoc, thì có thể đặt cầu hình trong jsdoc.json.

ngminhtrung 27-02-2018