Xóa bài viết
Bạn có chắc chắn muốn xóa bài viết này không ?
Xóa bình luận
Bạn có chắc chắn muốn xóa bình luận này không ?
JSdoc - Tạo documentation trực tiếp từ comments trong file JavaScript
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ặcmarkdown
. Nhưnghtml
có lẽ là định dạng chính. - Để chạy được
jsdoc
, cần:- Cài
jsdoc
thông quanpm 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 trongjsdoc.json
.
- Cài
ngminhtrung 27-02-2018
Bình luận

{{ comment.user.name }}
Bỏ hay
Hay

Cùng một tác giả

56
16
Đăng lại một bài đã viết từ cách đây mấy tháng. Chủ đề này đã có không ít, nhưng chẳng hiểu sao lượng bài tự viết của dân lập trình người Việt ta v...

28
6
Ghi chú: Tiêu đề hoàn toàn mang tính câu view. Bài copy từ blog của tác giả :) Tại sao lại có bài viết này? Một ngày đẹp giời tôi cần kiểm t...

18
4
Về bước tìm và xử lý dữ liệu của Việt Nam phục vụ Data Visualization nền web Làm việc với D3js được nửa năm, một trong những điều bận lòng là chưa...
Bài viết liên quan

1
5
fCC: Technical Documentation Page note So I have finished the HTML part of this exercise and I want to come here to lament about the lengthy HTML ...

3
1
Javascript inititalValue trong reduce() có quan trọng không? Day 41: Đọc code mẫu về hàm reduce() trong (Link), thấy hàm reduce() khá "đơn giản"....