fpdoc-3.0.0 - Trực tuyến trên Đám mây

CHƯƠNG TRÌNH:

TÊN

fpdoc - Trình tạo tài liệu đơn vị FPC Pascal.

SYNOPSIS

fpdoc --input = inputcommand [--output = output] [--format = fmt] [--descr = descriptionfile]
[--package = packagename] [options]

Mô tả

fpdoc quét tệp nguồn đơn vị Pascal Miễn phí và tạo tài liệu cho nó. Các
tài liệu có thể ở nhiều định dạng khác nhau (hiện tại là HTML và LaTeX) Nó có thể đọc nhiều
các tệp mô tả có chứa mô tả cho các ký hiệu khác nhau được tìm thấy trong đơn vị
tập tin.

Sử dụng

Bạn có thể gọi fpdoc với đối số bắt buộc duy nhất là 'đầu vào' và 'gói'
tranh luận. Nó ít nhất phải chứa tên của tệp đơn vị cho tài liệu
nên được tạo và tên của gói mà đơn vị đó thuộc về.

Các lựa chọn

fpdoc có một số tùy chọn, hầu hết trong số chúng là tùy chọn, mặc định sẽ được sử dụng trong hầu hết các trường hợp.

--Nội dung
Tùy chọn này cho biết fpdoc để tạo một tệp nội dung. Một tệp nội dung chứa một danh sách
tất cả các neo (nhãn) có thể có trong tệp tài liệu đã tạo và có thể
được sử dụng để tạo các liên kết chéo trong tài liệu cho các đơn vị khác nhau, bằng cách sử dụng
--nhập khẩu tùy chọn.

--cputarget = giá trị
Tùy chọn này cho biết fpdoc cho CPU nào để tạo tài liệu. Điều này đơn giản
xác định các macro CPU phù hợp.

--descr = descfile
Tùy chọn này chỉ định tên của tệp mô tả giải nén có chứa
tài liệu thực tế cho đơn vị. Tùy chọn này có thể được đưa ra nhiều lần, cho
một số tệp mô tả.

--descr-dir = dir
Tùy chọn này chỉ định tên của một thư mục có các tệp mô tả XML, được đặt tên là dir
Tùy chọn này có thể được đưa ra nhiều lần, đối với một số thư mục mô tả. Cái này
tùy chọn tương đương với việc chỉ định tất cả các tệp trong thư mục với --descr
tùy chọn.

--không cắt tỉa
Tùy chọn này yêu cầu fpdoc không cắt bỏ khoảng trắng trong các tệp XML. Theo mặc định,
khoảng trắng bị cắt khỏi đầu vào, điều này có thể gây ra các tác dụng phụ không mong muốn trong
ví dụ: thẻ PRE.

- chạy thử
Tùy chọn này cho biết fpdoc không tạo bất kỳ đầu ra nào, mà chỉ phân tích cú pháp tất cả đầu vào. Cái này
có thể được sử dụng với tùy chọn dài dòng để kiểm tra lỗi nào còn sót lại trong
tài liệu, hoặc những gì vẫn còn thiếu.

--format = fmt
Chỉ định định dạng fmt trong đó tài liệu sẽ được tạo. Currenly,
các định dạng sau được biết đến:

hm CHM với 8.3 tên tệp phù hợp, dành cho hầu hết các cửa sổ.

dxml Đầu ra XML tương thích với Delphi.

htm HTML với 8.3 tên tệp phù hợp.

html HTML với tên tệp dài.

ipf Đầu ra IPF (định dạng OS / 2, có thể được sử dụng với docview từ fpGUI).

xhtml XHTML với các tên tệp dài.

mủ cao su LaTex, sử dụng kiểu fpc.sty được sử dụng bởi tài liệu Free Pascal.

người đàn ông đầu ra trang người đàn ông (các trang thủ công unix, một trang cho mỗi mã định danh).

rtf Đầu ra RTF.

txt Đầu ra văn bản thuần túy.

cấu trúc xml
XML có cấu trúc.

--Cứu giúp Hiển thị tóm tắt tùy chọn dòng lệnh.

- được bảo vệ bằng da
Theo mặc định, tài liệu sẽ bao gồm các mô tả và danh sách các
các trường và phương thức trong các lớp hoặc đối tượng. Tùy chọn này thay đổi hành vi này; nếu nó
được chỉ định, sẽ không có tài liệu nào được tạo cho các phương pháp này. Lưu ý rằng
các phương thức công khai hoặc thuộc tính tham chiếu đến các phương thức được bảo vệ này sau đó sẽ có
liên kết lơ lửng (tức là không có sẵn).

--html-search = link
Thêm một mục nhập cho một trang tìm kiếm HTML tại vị trí Link trong tiêu đề của
các trang HTML được tạo. Không có trang tìm kiếm nào được cung cấp, điều này nên được thực hiện và
do người dùng cung cấp.

--import = impfile
nhập một tệp nội dung làm ô uế từ một bộ tài liệu khác. Điều này có thể được sử dụng để
giải quyết các tham chiếu đến các phần tử trong tệp tài liệu khác này;

--input = cmd
Tùy chọn này cho biết fpdoc tập tin đầu vào nào nên được sử dụng. Lý lẽ cmd có thể
chỉ là một tên tệp, nhưng cũng có thể là một dòng lệnh của trình biên dịch hoàn chỉnh với các tùy chọn
quan tâm đến việc quét nguồn pascal: định nghĩa, bao gồm tệp, tùy chọn cú pháp,
vì chúng sẽ được chỉ định cho trình biên dịch pascal miễn phí khi biên dịch tệp. Nếu như
một lệnh hoàn chỉnh được sử dụng, sau đó nó phải được đặt trong dấu ngoặc kép hoặc đơn,
vì vậy vỏ sẽ không bị vỡ chúng ra từng phần. Có thể chỉ định nhiều
các lệnh đầu vào; họ sẽ được xử lý từng người một, và tài liệu sẽ
được tạo cho mỗi người trong số họ.

--input-dir = dir
Tùy chọn này cho biết fpdoc để thêm tất cả các tệp .pas và .pp trong thư mục có tên cmd as
đầu vào tệp vào trình tài liệu. Điều này tương đương với việc chỉ định tất cả các tệp trong
thư mục với --đầu vào chỉ huy.

--lang = ngôn ngữ
Đặt ngôn ngữ cho tệp đầu ra. Điều này chủ yếu sẽ thiết lập các chuỗi được sử dụng cho
các tiêu đề trong các phần khác nhau của tệp tài liệu (theo mặc định, chúng nằm trong
tiếng Anh). Hiện tại, các tùy chọn hợp lệ là

de Tiếng Đức.

fr Người Pháp.

nl Hà Lan

--latex-extension = ext
Đặt phần mở rộng để sử dụng cho tệp LaTeX thành ext mặc định là .tex (với .
(chấm) bao gồm).

--latex-tô sáng
Bật công cụ đánh dấu cú pháp latex bên trong. Điều này vẫn chưa được thực hiện. Qua
mặc định, tô sáng cú pháp được cung cấp bởi gói cú pháp đi kèm với fpc.

--mo-dir = dir
Tùy chọn này cho biết fpdoc nơi để tìm các tệp dịch có thể được sử dụng để
quốc tế hóa đầu ra của fpdoc.

--ostarget = giá trị
Tùy chọn này cho biết fpdoc cho hệ điều hành nào để tạo tài liệu. Cái này
chỉ cần xác định các macro hệ điều hành phê duyệt.

--output = tên
Tùy chọn này cho biết fpdoc nơi tệp đầu ra sẽ được tạo. Làm thế nào tùy chọn này
được diễn giải phụ thuộc vào định dạng được sử dụng. Đối với cao su, tên được diễn giải
làm tên tệp cho tệp tex. Đối với tất cả các định dạng khác, tên được hiểu là
thư mục nơi tất cả các tệp tài liệu sẽ được viết. Thư mục sẽ là
được tạo nếu nó chưa tồn tại. Tiêu chuẩn này tương đương với tên gói.

--package = tên gói
Chỉ định tên gói. Tất cả các đơn vị sẽ được ghi lại như một phần của tên gói hàng ,
cũng là tên tệp hoặc thư mục đầu ra mặc định. Chỉ các nút tài liệu
bên trong một nút gói với tên này sẽ được xem xét khi lập tài liệu.

--prse-impl
(Thử nghiệm) cũng cố gắng phân tích cú pháp việc triển khai một đơn vị, điều này có thể được sử dụng cho
kiểm tra cú pháp.

--project = tệp
Tùy chọn này cho biết fpdoc để đọc tất cả các tùy chọn từ tệp dự án. Đây là một XML
, vui lòng xem tài liệu để biết thêm thông tin về định dạng cho tệp này
tập tin.

--show-riêng tư
Theo mặc định, không có tài liệu nào được tạo cho các phương thức hoặc trường riêng tư. Cái này
nguyên nhân tùy chọn fpdoc để tạo tài liệu cho các phương pháp này.

--dài dòng
Theo mặc định, fpdoc là thưa thớt với sản lượng. Điều này yêu cầu fpdoc tạo thêm một số
thông tin về những gì nó đang làm.

- lùn-không-nút
Nếu tùy chọn này được chỉ định, fpdoc sẽ phát ra cảnh báo nếu nó không tìm thấy
nút mô tả cho một định danh mà nó đang lập tài liệu.

--write-project = file
Nếu tùy chọn này được chỉ định, fpdoc sẽ ghi một tệp dự án fpdoc (vào
tên tệp được chỉ định) tương ứng với các tùy chọn dòng lệnh đã cho.

Sử dụng fpdoc-3.0.0 trực tuyến bằng các dịch vụ onworks.net