cxref - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

cxref - C Cross Referencing & Documenting tool.

SYNOPSIS

cxref tên tập tin [ hữu ích. Cảm ơn ! tên tệp] [-Onói cho tôi] [-Ntên cơ sở] [-NStên cơ sở] [-tất cả-bình luận]
[-miễn bình luận] [-nguyên văn-bình luận] [-khối-bình luận]
[-xref [-all] [- file] [- func] [- var] [- type]] [-anh [-all] [- comment] [- xref]]
[-index [-all] [- file] [- func] [- var] [- type]] [-thô] [-mủ cao su] [-html [-src]] [-rtf] [-sgml]
[-TÔInói cho tôi] [-NSđịnh nghĩa] [-Uđịnh nghĩa] [-CPP cpp_chương trình] [- cpp_args hữu ích. Cảm ơn ! cpp_args]

cxref tên tập tin [ hữu ích. Cảm ơn ! tên tệp] -xóa bỏ [-Onói cho tôi] [-Ntên cơ sở] [-NStên cơ sở]

MÔ TẢ

Một chương trình có thể tự động tạo tài liệu và tham chiếu chéo cho một C
chương trình.

Đầu vào là bất kỳ chương trình C nào có chú thích thích hợp và đầu ra là LaTeX, HTML, RTF hoặc
Tệp SGML.

LỰA CHỌN

tên tập tin
Tên của tệp thành tài liệu, bất kỳ số lượng tệp nào có thể được lập thành tài liệu tại một thời điểm.

-xóa bỏ
Các tệp có tên sẽ bị xóa khỏi thư mục đầu ra và các mục nhập của chúng trong
cơ sở dữ liệu tham chiếu chéo và các tệp đầu ra chính sẽ bị xóa.

-Tên họ
Tên của một thư mục để sử dụng cho các tệp latex đầu ra và vị trí của
các tệp tham chiếu chéo được tạo.

-Tên cơ sở
Tên sẽ sử dụng cho phần đầu tiên của tệp đầu ra và tệp tham chiếu chéo để thay thế
của cxref, các phần mở rộng tệp vẫn được giữ nguyên.

-Tên họ
Khi các tệp nguồn nằm trong nhiều thư mục, hãy đặt tên dirname thành tên của
thư mục gốc của cây nguồn (sử dụng đường dẫn tương đối nếu dễ dàng hơn, ví dụ như `-R ../ ..').
Thao tác này sau đó sẽ chạy cxref từ thư mục gốc đó và `-Odirname 'phải là
liên quan đến thư mục đó.

-tất cả các bình luận
Trong trường hợp bạn nghĩ rằng các nhận xét hiện có có thể hoạt động, (xem phần mô tả ở trên
của các bình luận đặc biệt). [Sự nguy hiểm! Tùy chọn này có thể tạo ra kết quả kỳ lạ.]

-miễn bình luận
Bỏ qua tất cả các nhận xét, hữu ích nếu bạn chỉ muốn các tham chiếu chéo chứ không phải
tài liệu hướng dẫn.

-batim-bình luận
Khi các nhận xét mà bạn có trong mã được định dạng theo kiểu định trước
mà bạn muốn duy trì trên đầu ra, tùy chọn này sẽ buộc họ không
được định dạng lại. [Lưu ý, điều này chỉ dành cho các nhận xét về tệp và hàm.]

-block-comment
Khi các nhận xét trong chương trình được định dạng theo kiểu khối (khối) (với
ký tự '*' trên mọi dòng), tùy chọn này sẽ xóa ký tự đó khỏi
đầu ra. [Hoạt động cho một dấu `* ',` +', `| ' hoặc `: 'trên mỗi dòng.]

-xref Đưa ra thông tin tham khảo chéo (xem bên dưới).
-tất cả Tất cả các tài liệu tham khảo chéo.
-tệp Tham chiếu chéo cho các tệp.
-func Tham chiếu chéo cho các chức năng.
-var Tham chiếu chéo cho các biến.
-type Tham chiếu chéo cho các loại.

-cảnh báo Đưa ra các cảnh báo, các tùy chọn phải được nối với nhau:
-tất cả Tất cả các cảnh báo.
-nhận xét Cảnh báo những bình luận còn thiếu.
-xref Cảnh báo thiếu các tham chiếu chéo.

-mục lục Tạo chỉ mục tham chiếu chéo, các tùy chọn phải được nối với nhau:
-tất cả các chỉ mục.
-tệp Chỉ mục của tệp.
-func Chỉ số chức năng.
-var Chỉ số của các biến.
-type Chỉ số các loại.

-nguyên Sản xuất một dạng đầu ra thô, không thực sự có giá trị sử dụng nhiều ngoại trừ với -warn.

-mủ cao su Tạo tệp LaTeX để ghi lại từng tệp nguồn và cả tệp bổ sung
bao gồm từng tệp này.

-html Tạo tệp HTML 4.01 để ghi lại từng tệp nguồn và tệp chính để
tham chiếu từng tệp này.

-html-src
Tạo đầu ra HTML và phiên bản HTML của tệp nguồn với các liên kết trong đó.

-rtf Tạo tệp Định dạng Văn bản Đa dạng thức (RTF) để ghi lại tệp nguồn.

-sgml Tạo tệp SGML để ghi lại tệp nguồn. (Sử dụng LinuxDoc DTD).

-Tên họ
Tùy chọn GCC để chỉ định đường dẫn cho các tệp bao gồm.

-Xác định
Tùy chọn GCC để xác định một ký hiệu tiền xử lý.

-Xác định
Tùy chọn GCC để hoàn tác ký hiệu bộ xử lý trước.

-CPP chương trình
Tên của chương trình để sử dụng thay cho thời gian biên dịch mặc định. Chương trình
phải có thể thực hiện tất cả các hành động mà `gcc -E -C -dD 'thực hiện để hoạt động. Nếu như
chương trình nhận các đối số thì toàn bộ điều cần phải được đặt trong dấu ngoặc kép để nó
được hiểu là một đối số duy nhất cho cxref.

--arg hữu ích. Cảm ơn ! arg
Các đối số bổ sung được chuyển đến bộ xử lý trước có thể được đặt sau dấu `- '
dải phân cách.

C Trình biên dịch Thay thế cxref-cc
Để đơn giản hóa việc sử dụng cxref trên mã nguồn hiện có, bây giờ có một tập lệnh shell sẽ
gọi trình biên dịch C và sau đó gọi cxref để xử lý tệp nguồn. Điều này có nghĩa là nó
có thể được sử dụng để thay thế CC trong Makefiles và những thứ tương tự.

Cách sử dụng: cxref-cc [tùy chọn cc thông thường]

Tên của tệp nguồn được trích xuất từ ​​danh sách các tùy chọn cũng như `` -D * '',
Các cờ `-I * ',` -U *' và khi trình biên dịch C thoát thành công, cxref sẽ được gọi. Các
tên của trình biên dịch C để sử dụng được điều khiển bởi biến môi trường CXREFCC, hoặc nếu
điều này không được đặt sau đó biến môi trường CC, hoặc lỗi này chỉ là gcc.

Sử dụng tập lệnh này yêu cầu sử dụng tệp cấu hình `.cxref 'để chứa các tùy chọn
vì không có chỗ nào để đặt các tùy chọn trên dòng lệnh cho trình biên dịch C.

Điều này sẽ chỉ tham chiếu chéo và ghi lại các tệp nguồn C vì chúng là tệp duy nhất
những cái được biên dịch, nhưng nó sẽ đảm bảo rằng chúng được tham chiếu chéo với
các tùy chọn chính xác, v.v.

Cxref Cấu hình Tập tin
Các đối số dòng lệnh này cũng có thể được đưa vào một tệp có tên là `.cxref 'thay vì trên
dòng lệnh. Khi cxref được chạy, các đối số của chương trình được diễn giải trong
làm theo nguyên tắc.

(1) Những người trên dòng lệnh. (2) Những cái trong tệp `.cxref 'trong thư mục hiện tại.
(3) Những cái trong tệp `.cxref 'trong gốc cây nguồn được chỉ định bởi` -R'.

Điều này có nghĩa là trong cây nguồn đa thư mục, mỗi thư mục con có thể có một `.cxref '
tệp chỉ chứa dòng `-R .. 'hoặc thích hợp. Thư mục chính có thể có
Tập tin `.cxref 'chứa phần còn lại của các tùy chọn. Điều này loại bỏ hoàn toàn nhu cầu
để có bất kỳ tùy chọn nào trên dòng lệnh ngoài tên tệp nguồn.

Định dạng của tệp `.cxref 'là bất kỳ số dòng nào, mỗi dòng chứa một
đối số dòng lệnh (tương đương với một trong các argv). Các lựa chọn duy nhất không thể
được sử dụng là tên của chính các tệp nguồn và tùy chọn `-delete '. Dòng trống là
bị bỏ qua và các dòng bắt đầu bằng '#' là nhận xét.

chương trình Tài liệu Nhận xét
Tài liệu cho chương trình được tạo ra từ các nhận xét trong mã
được định dạng thích hợp. Tham chiếu chéo đến từ chính mã và không yêu cầu
làm thêm.

Các nhận xét đặc biệt là `/ **** **** / '(đối với tệp) và` / * ++++ ++++ * /' (đối với dữ liệu
đối tượng) bất kỳ số lượng dấu `* 'hoặc` +' nào đều có thể được sử dụng bên trong nhận xét tiêu chuẩn `/ * 'và` * /'
các dấu phân cách trong các bình luận, chúng bị bỏ qua.

Nếu một dòng nhận xét bắt đầu bằng khoảng trắng và theo sau là `+ html + 'thì phần còn lại của
dòng chỉ được bao gồm trong đầu ra HTML và không được xử lý để nó có thể bao gồm HTML
markup, `-html- 'có nghĩa là phần còn lại của dòng được bao gồm trong tất cả ngoại trừ HTML
đầu ra. Điều tương tự cũng áp dụng cho các định dạng đầu ra khác, `` + none + 'có thể được sử dụng cho các dòng
không xuất hiện trong bất kỳ đầu ra nào. Ngoại lệ cho điều này là đầu ra thô không làm bất kỳ
kiểm tra và sẽ xuất ra tất cả các dòng.

Trong bất kỳ tình huống nào mà một bình luận theo sau dấu ',', ';' hoặc ')' chỉ được phân tách bằng dấu cách và
tab, chú thích được đẩy lên trước dấu câu để áp dụng cho đối tượng ở đó.

Chương trình được triển khai bằng trình phân tích cú pháp ngữ pháp ANSI C đầy đủ với một số phần mở rộng GCC,
điều này có nghĩa là phong cách của mã không quan trọng, chỉ có nội dung và nhận xét.

Vượt qua Tham khảo
Tham chiếu chéo được thực hiện cho các mục sau

Các tập tin
Các tệp mà tệp hiện tại được bao gồm trong
(ngay cả khi được bao gồm qua các tệp khác).

#bao gồm
Các tệp có trong tệp hiện tại.
Các tệp được bao gồm bởi các tệp này, v.v.

Biến
Vị trí của định nghĩa các biến bên ngoài.
Các tệp có khả năng hiển thị các biến toàn cục.
Các tệp / hàm sử dụng biến.

Chức năng
Tệp mà hàm được tạo nguyên mẫu.
Các hàm mà hàm gọi.
Các hàm gọi hàm.
Các tệp và hàm tham chiếu đến hàm.
Các biến được sử dụng trong hàm.

Mỗi mục này được tham chiếu chéo trong đầu ra.

Tham chiếu chéo sử dụng các tệp `cxref.variable ',` cxref. Chức năng', `cxref.include 'và
`cxref.typedef 'trong thư mục đầu ra. Đây là danh sách đầy đủ của chức năng và
sử dụng biến trong chương trình và có thể được sử dụng để tạo phân cấp lệnh gọi hàm hoặc
sơ đồ sử dụng biến chẳng hạn. Hai lần chuyển cxref của mỗi tệp là cần thiết, lần đầu tiên
xây dựng các tệp tham chiếu chéo và thứ hai để sử dụng chúng.

(Tên tệp sẽ khác nếu tùy chọn `-N 'được sử dụng.)

Mủ cao su Đầu ra
Đầu ra LaTeX mặc định là một tệp cho mỗi tệp nguồn với một tệp bổ sung
`cxref.tex 'bao gồm từng tệp khác. Điều này chỉ cho phép một makefile
cập nhật các tệp đã thay đổi (mặc dù các tham chiếu có thể yêu cầu tất cả các tệp
đã kiểm tra lại). Khi tệp cxref.tex đã được viết, người dùng có thể sửa đổi tệp đó,
bất kỳ tệp mới nào được thêm vào sẽ được thêm vào cuối phần mã nguồn, phần còn lại của
tệp không thay đổi.

Chỉ mục được ghi vào một tệp có tên là `cxref.apdx.tex 'và cxref.tex được cập nhật để tham chiếu
với nó.

Cũng được viết ra là ba tệp kiểu LaTeX `page.sty ',` fonts.sty' và `cxref.sty '.
Những điều này thiết lập trang để sử dụng lề nhỏ hơn và phông chữ nhỏ hơn để cho phép nhiều hơn xuất hiện trên
một trang và cũng xác định các lệnh mới để sắp chữ đầu ra cxref.

(Tên tệp `cxref.tex 'và` cxref.apdx.tex' khác nhau nếu tùy chọn `-N 'là
đã sử dụng.)

HTML Đầu ra
Đầu ra HTML mặc định là một tệp cho mỗi tệp nguồn với một tệp bổ sung
`cxref.html 'bao gồm từng tệp khác. Điều này chỉ cho phép một makefile
cập nhật các tệp đã thay đổi (mặc dù các tham chiếu có thể yêu cầu tất cả các tệp
đã kiểm tra lại). Khi tệp cxref.html đã được viết, người dùng có thể sửa đổi tệp đó,
bất kỳ tệp mới nào được thêm vào sẽ được thêm vào cuối trước mục lục, phần còn lại
của tệp không thay đổi.

Chỉ mục được ghi vào tệp có tên là `cxref.apdx.html 'và cxref.html được cập nhật để tham khảo
với nó.

(Tên tệp `cxref.html 'và` cxref.apdx.html' khác nhau nếu tùy chọn `-N 'là
đã sử dụng.)

Đầu ra HTML sử dụng tiêu chuẩn HTML 4.01 và tất cả các trang đều xác thực chính xác.

RTF Đầu ra
Định dạng Văn bản Đa dạng thức là một định dạng mô tả trang ở cấp độ khá thấp do Microsoft phát minh ra. Nó
không phải là một tiêu chuẩn được xác định rõ ràng và dễ hiểu như các định dạng khác, nhưng nó là
phổ biến để trao đổi tài liệu.

Có một tệp đầu ra duy nhất cho mỗi tệp nguồn và một tệp chỉ mục.

SGML Đầu ra
Vì SGML là một siêu ngôn ngữ nên cần phải xác định các thành phần bố cục cũng như
cung cấp thông tin. Đầu ra cxref sử dụng định dạng tài liệu LinuxDoc và là
được thiết kế để sử dụng với các chương trình SGMLtools (http://www.sgmltools.org/).

Có một tệp đầu ra duy nhất cho mỗi tệp nguồn và một tệp chỉ mục.

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