JSdoc - Tạo documentation trực tiếp từ comments trong file JavaScript
TIL
748
@100daysTIL
72
White

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

Bình luận


White
{{ comment.user.name }}
Bỏ hay Hay
{{comment.like_count}}
Male avatar
{{ comment_error }}
Hủy
   

Hiển thị thử

Chỉnh sửa

White

Minh-Trung Nguyễn

63 bài viết.
120 người follow
Kipalog
{{userFollowed ? 'Following' : 'Follow'}}
Cùng một tác giả
White
53 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...
Minh-Trung Nguyễn viết 2 năm trước
53 16
White
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...
Minh-Trung Nguyễn viết hơn 2 năm trước
28 6
White
17 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...
Minh-Trung Nguyễn viết 2 năm trước
17 4
Bài viết liên quan
White
0 4
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 ...
HungHayHo viết 2 năm trước
0 4
White
3 0
I used Spring boot, Hibernate few times back then at University, I'v started using it again recently. In this (Link), I want to check how Spring J...
Rey viết hơn 1 năm trước
3 0
{{like_count}}

kipalog

{{ comment_count }}

bình luận

{{liked ? "Đã kipalog" : "Kipalog"}}


White
{{userFollowed ? 'Following' : 'Follow'}}
63 bài viết.
120 người follow

 Đầu mục bài viết

Vẫn còn nữa! x

Kipalog vẫn còn rất nhiều bài viết hay và chủ đề thú vị chờ bạn khám phá!