Đây là lệnh jsdoc có thể chạy trong nhà cung cấp dịch vụ lưu trữ miễn phí OnWorks bằng cách sử dụng một trong nhiều máy trạm trực tuyến miễn phí của chúng tôi như Ubuntu Online, Fedora Online, trình giả lập trực tuyến Windows hoặc trình giả lập trực tuyến MAC OS
CHƯƠNG TRÌNH:
TÊN
jsdoc - trình tạo tự động cho tài liệu HTML của các nguồn Javascript
SYNOPSIS
jsdoc {-d = | --directory =} [lựa chọn] ...
jsdoc [{-h | --Cứu giúp}]
MÔ TẢ
Trang hướng dẫn sử dụng này tài liệu ngắn gọn về jsdoc chỉ huy.
jsdoc là ứng dụng, được viết bằng JavaScript, để tự động tạo
tài liệu định dạng mẫu, HTML nhiều trang (hoặc XML, JSON hoặc bất kỳ tài liệu dựa trên văn bản nào khác)
từ mã nguồn JavaScript đã nhận xét.
LỰA CHỌN
Chương trình tuân theo cú pháp dòng lệnh GNU thông thường, với các tùy chọn dài bắt đầu bằng hai
dấu gạch ngang (`- '). Dưới đây là một bản tóm tắt các tùy chọn. Để có mô tả đầy đủ, hãy xem
Thông tin(1) tệp.
-a, - chức năng
Bao gồm tất cả các chức năng, ngay cả những chức năng không có giấy tờ.
-c, --conf
Tải tệp cấu hình.
-d =, --directory =
Xuất ra thư mục này (tham số bắt buộc).
-D ="myVar: Của tôi giá trị", --define ="myVar: Của tôi giá trị"
Nhiều. Xác định một biến, có sẵn trong JsDoc là JSDOC.opt.D.myVar.
-e =, --encoding =
Sử dụng bảng mã này để đọc và ghi tệp.
-E ="REGEX", --exclude ="REGEX"
Nhiều. Loại trừ các tệp dựa trên regex được cung cấp.
-h, --Cứu giúp
Hiển thị thông báo này và thoát.
-m, --bội số
Đừng cảnh báo về các biểu tượng được ghi lại nhiều lần.
-n, --không có mã
Bỏ qua tất cả mã, chỉ nhận xét tài liệu bằng thẻ @name.
-o =, --out =
In thông báo nhật ký vào một tệp (mặc định là stdout).
-p, --riêng
Bao gồm các biểu tượng được gắn thẻ là biểu tượng riêng tư, gạch dưới và bên trong.
-q, --Yên lặng
Không xuất ra bất kỳ thông báo nào, thậm chí không có cảnh báo.
-r =, --recurse =
Đi xuống thư mục src.
-s, --kìm nén
Chặn đầu ra mã nguồn.
-S, - mô-đun bảo mật
Sử dụng chế độ Mô-đun bảo mật để phân tích cú pháp mã nguồn.
-t =, --template =
Sử dụng mẫu này để định dạng đầu ra.
-T, --kiểm tra
Chạy tất cả các bài kiểm tra đơn vị và thoát.
-u, --duy nhất
Buộc tên tệp là duy nhất, nhưng không dựa trên tên ký hiệu.
-v, --dài dòng
Cung cấp phản hồi chi tiết về những gì đang xảy ra.
-x =[, EXT] ..., --ext =[, EXT] ...
Quét các tệp nguồn với / s phần mở rộng đã cho (mặc định là js).
Sử dụng jsdoc trực tuyến bằng các dịch vụ onworks.net
