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

CHƯƠNG TRÌNH:

TÊN

monodocer - Hỗ trợ định dạng tài liệu ECMA

SYNOPSIS

người độc tài [TÙY CHỌN]*

LỰA CHỌN

-cấu tạo: LẮP RÁP
HỘI là một hợp ngữ .NET để tạo các sơ khai tài liệu.

Chỉ định đường dẫn tệp hoặc tên của hội đồng GAC'd.

-xóa bỏ
Cho phép monodocer xóa các thành viên khỏi các tệp tài liệu. Các thành viên duy nhất
bị xóa dành cho các thành viên không còn hiện diện trong hội đồng.

Nếu một loại không còn tồn tại, tệp tài liệu sẽ không đã xóa, nhưng là
thay vì đã đổi tên để có một .tẩy gia hạn.

- ?, -Cứu giúp
Hiển thị thông tin đối số của chương trình.

-các thành viên lớn tuổi
Không cập nhật thành viên.

Thao tác này sẽ thêm các gốc tài liệu cho các loại được thêm vào, nhưng sẽ không thêm hoặc loại bỏ
tài liệu cho bất kỳ thành viên nào thuộc bất kỳ loại nào (bao gồm bất kỳ loại bổ sung nào).

-importslashdoc: FILE
FILE là một tệp XML được tạo bằng / doc: FILE Cờ trình biên dịch C # (ví dụ: mcs
-doc: foo.xml foo.cs ). Nhập tài liệu thành viên có trong FILE trong
định dạng tài liệu được monodoc sử dụng.

-tên tên
TÊN là tên của dự án mà tài liệu này dành cho.

Điều này đặt / Tổng quan / Tiêu đề phần tử trong chỉ mục.xml tệp được tạo tại
thư mục được chỉ định bởi -con đường . Điều này được một số chương trình sử dụng cho thông tin tiêu đề
(ví dụ monodocs2html ).

-không gian tên: NAMESPACE
Chỉ cập nhật các loại trong không gian tên KHÔNG GIAN TÊN .

-ghi đè
Bao gồm các phương thức bị ghi đè trong tài liệu.

Điều này thường không cần thiết, vì Trình duyệt Tài liệu Mono sẽ cung cấp
liên kết với các thành viên loại cơ sở theo ý muốn monodocs2html nếu loại cơ sở là
trong cùng một tổ hợp.

-path: OUTPUT_DIR
OUTPUT_DIR là thư mục sẽ chứa các gốc tài liệu mới / cập nhật.

-đẹp
Thụt lề các tệp XML một cách độc đáo.

-từ: SINCE
Tạo một phần tử cho các loại và thành viên được bổ sung với giá trị TỪ .

Ví dụ, khi cho -từ: "Gtk # 2.4 " một phần tử sẽ được chèn vào Tài liệu
phần tử cho tất cả các loại được thêm vào và loại thành viên:

Trình duyệt Tài liệu Mono và monodocs2html sẽ sử dụng phần tử này để chỉ định
trong đó phiên bản một thành viên đã được thêm vào.

-type: TYPE
Chỉ tạo / cập nhật tài liệu cho loại LOẠI .

-updateto: PATH
Khi cập nhật tài liệu, hãy ghi các tệp tài liệu cập nhật vào
thư mục PATH .

-V, -phiên bản
Hiển thị phiên bản và thông tin cấp phép.

MÔ TẢ

người độc tài đã bị khuất phục bởi mdoc(1). Xem cập nhật mdoc(1) trang người.

người độc tài là một chương trình tạo các gốc tài liệu XML trong Tài liệu ECMA
Sự sắp xếp. Nó không dựa trên tài liệu được tìm thấy trong mã nguồn.

Những ưu điểm là:

* Mã khả năng đọc. Tài liệu tốt thường là (a) dài, và (b) điền
với các ví dụ. (Để so sánh, hãy so sánh tài liệu Microsoft .NET Framework,
thường là một trang hoặc nhiều tài liệu cho mỗi thành viên, đối với tài liệu JavaDoc,
thường có thể là một câu cho mỗi thành viên.)

Chèn tài liệu tốt vào mã nguồn thường xuyên có thể làm cho nguồn bị phình ra
tệp, vì tài liệu có thể dài hơn phương pháp thực tế đang được
tài liệu.

* Nội địa hóa. Định dạng tài liệu trong nguồn (chẳng hạn như / doc ) không có hỗ trợ cho
nhiều ngôn ngữ của con người. Nếu bạn cần hỗ trợ nhiều hơn một ngôn ngữ con người cho
mục đích tài liệu, người độc tài rất hữu ích vì nó cho phép mỗi ngôn ngữ có được
thư mục riêng, và người độc tài có thể thêm các loại / thành viên cho từng tài liệu riêng biệt
thư mục.

* Quản trị. Không có gì lạ khi có tài liệu và phát triển riêng biệt
đội. Cũng có thể nhóm tài liệu sẽ có ít kinh nghiệm
với ngôn ngữ lập trình đang được sử dụng. Trong những trường hợp như vậy, nội tuyến
tài liệu không được mong muốn vì nhóm tài liệu có thể vô tình chèn
lỗi đối với mã nguồn trong khi cập nhật tài liệu. Ngoài ra, bạn
có thể không muốn nhóm tài liệu có quyền truy cập vào mã nguồn để bảo mật
lý do. người độc tài cho phép tài liệu được lưu giữ hoàn toàn tách biệt và
khác với mã nguồn được sử dụng để tạo hợp ngữ.

Để biến người độc tài tài liệu về thứ gì đó có thể được sử dụng bởi Mono
Trình duyệt Tài liệu (trình duyệt trợ giúp trên máy tính để bàn, hoặc giao diện web cho nó)
cần thiết để biên dịch tài liệu thành một định dạng đóng gói. Điều này được thực hiện với
công cụ mdassembler chẳng hạn, bạn có thể sử dụng chuỗi công cụ này như sau:

$ monodocer -assembly: MyWidgets -path: created_docs
$ mdassembler --ecma created_docs -out: MyWidgets

Ở trên sẽ tạo MyWidgets.zip và MyWidgets.tree sau đó có thể được cài đặt
trong hệ thống. Ngoài hai tệp (.zip và .tree), bạn phải cung cấp .sources
tệp mô tả vị trí trong hệ thống trợ giúp mà tài liệu sẽ được kết nối, nó là
một tệp XML rất đơn giản, như thế này:






Tệp cấu hình ở trên mô tả rằng tài liệu ở định dạng ECMA (
phiên bản đã biên dịch) mà tên tệp cơ sở là MyWidgets và nó phải được nối vào
phần "classlib-gnome" của cây. Nếu bạn muốn xem các nút khác nhau được xác định
trong tài liệu, bạn có thể xem tệp monodoc.xml thường được cài đặt trong
/usr/lib/monodoc/monodoc.xml.

Khi bạn có tất cả các tệp của mình (.zip, .tree và .sources), bạn có thể cài đặt chúng vào
hệ thống bằng lệnh sau:

$ cp MyWidgets.tree MyWidgets.zip MyWidgets.source `pkg-config monodoc --variable sourcedir`

Ở trên sẽ sao chép các tập tin vào thư mục mà Monodoc đã đăng ký (bạn có thể
cần quyền root để thực hiện việc này). Thư mục thực tế được trả về bởi pkg-config
sự cầu khẩn.

STRING ID FORMAT

ID chuỗi được sử dụng để chỉ một loại hoặc thành viên của một loại. ID chuỗi được ghi lại trong
ECMA-334 Phiên bản thứ 3, Phụ lục E.3.1. Chúng bao gồm một hội viên kiểu tiếp đầu ngữ , loại đầy đủ
tên (không gian tên + tên, được phân tách bằng '.'), có thể theo sau là tên thành viên và tên khác
thông tin.

Tiền tố loại thành viên:

E: ID chuỗi đề cập đến một sự kiện. Tên sự kiện theo sau tên loại:
E: System.AppDomain.AssemblyLoad

F: ID chuỗi tham chiếu đến một trường. Tên trường theo sau tên loại:
F: System.Runtime.InteropServices.DllImportAttribute.SetLastError

M: Đề cập đến một phương thức hoặc phương thức khởi tạo. Constructors append .ctor đến tên loại,
trong khi các phương thức nối tên phương thức (với số lượng tùy chọn là
tham số chung).

Nếu hàm tạo hoặc phương thức nhận đối số, chúng được liệt kê trong dấu ngoặc đơn
sau tên phương thức / hàm tạo:

M: System.Object..ctor , M: System.String..ctor (System.Char []) ,
M: System.String.Concat (System.Object) , M: System.Array.Sort``1 (`` 0 []) ,
M: System.Collections.Generic.List`1..ctor ,
M: System.Collections.Generic.List`1.Add (`0) .

N: Đề cập đến một không gian tên, ví dụ: N: Hệ thống

P: Đề cập đến một tài sản. Nếu thuộc tính là một trình lập chỉ mục hoặc nhận các tham số, thì
các kiểu tham số được nối vào tên thuộc tính và kèm theo dấu ngoặc kép:
P: System.String.Length , P: System.String.Chars (System.Int32) .

T: ID chuỗi đề cập đến một loại, với số lượng các loại chung được thêm vào:
T: System.String , T: System.Collections.Generic.List`1

Để làm cho vấn đề thú vị hơn, các loại & thành viên chung có hai cách đại diện:
biểu diễn "không liên kết" (được hiển thị trong các ví dụ ở trên), trong đó các tên lớp có tổng số
các tham số chung được thêm vào tên của chúng. Ngoài ra còn có một đại diện "ràng buộc", trong
mà liên kết của các tham số chung được liệt kê trong '{' và '}'.

Không ràng buộc: T: System.Collections.Generic.List`1 , T: System.Collections.Generic.Dictionary`2 .

Ràng buộc: T: System.Collections.Generic.List {System.Int32}
T: System.Collections.Generic.Dictionary {System.String, System.Collections.Generic.List {System.Predicate {System.String}}}
.

Như bạn có thể thấy, các biến thể ràng buộc có thể phức tạp tùy ý (giống như generic).

Hơn nữa, nếu một tham số chung được liên kết với tham số chung của một kiểu hoặc phương thức,
"chỉ mục" của tham số chung của kiểu / phương thức được sử dụng làm liên kết, do đó
lớp FooType {
public static void Foo (Hệ thống.Predicate Thuộc tính) {}
}
ID chuỗi cho phương pháp này là M: FooType.Foo``1 (System.Predicate {`` 0}) , Như `` 0 là
Chỉ số tham số chung thứ 0 được liên kết với System.Predicate .

TÀI LIỆU FORMAT

người độc tài tạo tài liệu tương tự như định dạng tài liệu Ecma, như được mô tả
trong ECMA-335 Phiên bản thứ 3, Phân vùng IV, Chương 7.

Sự khác biệt cơ bản so với định dạng ECMA là mỗi loại có tệp riêng, trong
một thư mục giống hệt với không gian tên của kiểu.

Hầu hết thông tin trong tài liệu nên không được chỉnh sửa. Điều này bao gồm
tên loại ( / Type / @ FullName ), các giao diện đã triển khai ( / Loại / Giao diện ), thành viên
thông tin ( / Loại / Thành viên / Thành viên / @ MemberName , / Loại / Thành viên / Thành viên / Thành viên Chữ ký ,
/ Loại / Thành viên / Thành viên / Loại thành viên , / Loại / Thành viên / Thành viên / Thông số , Vv).

Điều gì nên được sửa đổi là tất cả các phần tử với văn bản Đến be thêm vào. , hiện tại
theo // Tài liệu các yếu tố (ví dụ: / Loại / Tài liệu , / Loại / Thành viên / Thành viên / Tài liệu ). Nội dung
của Tài liệu nguyên tố là giống hệt nhau về ngữ nghĩa và cấu trúc của tài liệu C # nội tuyến
định dạng, bao gồm các yếu tố này (được liệt kê trong ECMA-334 Phiên bản thứ 3, Phụ lục E, Phần 2).
Những điều sau được sử dụng trong phần mô tả phần tử:

CREF Tham chiếu đến một tham chiếu lớp (hoặc thành viên) và là một chuỗi ở định dạng được mô tả
ở trên trong STRING ID FORMAT phần.

TEXT Văn bản không phải XML và XML không được lồng vào nhau.

XML Chỉ các phần tử XML nên được lồng vào nhau (có thể gián tiếp chứa văn bản), nhưng không
văn bản khoảng trắng không được là một nút con ngay lập tức.

XML_TEXT
Văn bản và XML dạng tự do để các phần tử XML khác có thể được lồng vào nhau.

Các yếu tố sau được sử dụng trong tài liệu:

<chặn subset = "SUBSET" type = "TYPE"> XML_TEXT
Tạo một khối văn bản, có khái niệm tương tự như một đoạn văn, nhưng được sử dụng để tạo
sự phân chia trong văn bản. Ở một mức độ nào đó, một tương đương với HTML
nhãn.

TẬP HỢP CON nên luôn luôn là giá trị không ai .

LOẠI chỉ định tiêu đề và định dạng để sử dụng. Các loại được công nhận là:

hành vi Tạo một phần với tiêu đề hoạt động .

ghi Tạo một phần với tiêu đề Lưu ý: .

ghi đè Tạo một phần với tiêu đề Chú thích đến Người thừa kế .

sử dụng Tạo một phần với tiêu đề Sử dụng .

XML_TEXT
Đặt văn bản bằng phông chữ giống mã (tương tự như phần tử HTML ).

<mã lang = "LANGUAGE"> TEXT
Hiển thị nhiều dòng văn bản trong một phông chữ giống mã (tương tự như HTML
thành phần). NGÔN NGỮ là ngôn ngữ mà khối mã này dành cho. Ví dụ, nếu
NGÔN NGỮ is C# thì TEXT sẽ nhận được đánh dấu cú pháp cho ngôn ngữ C # trong
Trình duyệt Tài liệu Mono.

XML_TEXT
Chỉ ra một ví dụ cần được hiển thị đặc biệt. Ví dụ:

Một đoạn văn giới thiệu.

Ví dụ lớp học {
khoảng trống tĩnh công khai Chính ()
{
System.Console.WriteLine ("Xin chào, Thế giới!");
}
}



<ngoại lệ cref = "CREF"> XML_TEXT
Xác định một ngoại lệ có thể được ném bởi thành viên được tài liệu.

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

CREF là loại ngoại lệ được ném ra, trong khi XML_TEXT chứa
hoàn cảnh sẽ gây ra CREF được ném.

là .


XML
Tạo một danh sách hoặc bảng các mục. sử dụng lồng nhau XML ,
XML , XML_TEXT và
XML_TEXT yếu tố.

Chức năng có cú pháp:

Dấu đầu dòng 1
Dấu đầu dòng 2
Dấu đầu dòng 3


Bàn có cú pháp:


Cột 1
Cột 2
Cột 3


Mục 1-A
Mặt hàng 1-B
Mặt hàng 1-C


Mục 2-A
Mặt hàng 2-B
Mặt hàng 2-C



XML_TEXT
Chèn một đoạn văn của XML_TEXT
. Điều này được sử dụng trong các thẻ khác, chẳng hạn như , ,
, và (xem , ở trên), và hầu hết các yếu tố khác.

Ví dụ,
Đây là một đoạn văn bản.

<thông số name = "NAME"> XML_TEXT
là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Mô tả tham số TÊN của hàm tạo, phương thức hoặc thuộc tính hiện tại:

MỘT chứa số
trong số các vật dụng để xử lý.


<paramref name = "NAME" />
Chỉ ra rằng TÊN là một tham số.

Điều này thường hiển thị TÊN là văn bản in nghiêng, vì vậy nó thường (ab) được sử dụng như một
tương đương với phần tử HTML . Xem tài liệu (ở trên)
Ví dụ.

<quyền cref = "CREF"> XML_TEXT
Ghi lại các yêu cầu về khả năng tiếp cận bảo mật của thành viên hiện tại.

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

CREF là một loại tham chiếu đến quyền bảo mật được yêu cầu, trong khi XML_TEXT là một
mô tả lý do tại sao quyền được yêu cầu.

Yêu cầu quyền đọc và ghi tệp. Nhìn thấy
,
.


XML_TEXT
Chứa thông tin chi tiết về một thành viên.

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.
Chèn thông tin chi tiết tại đây.

XML_TEXT

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Mô tả giá trị trả về của một phương thức:

MỘT xác định liệu
hoặc không quá trình có thể truy cập
.


<thấy cref = "CREF" />
Tạo liên kết đến thành viên được chỉ định trong văn bản hiện tại:


<xem thêm cref = "CREF" />

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Cho phép một mục nhập được tạo cho Xem Ngoài ra mục con. Sử dụng để cụ thể hóa
một liên kết từ bên trong văn bản.


<kể từ đó version = "VERSION" />

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Đặc điểm kỹ thuật cho phép của phiên bản nào đã giới thiệu loại hoặc thành viên được chỉ định.


SỰ MÔ TẢ

là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Cung cấp một cái nhìn tổng quan (ngắn gọn!) Về một loại hoặc loại thành viên.

Điều này thường được hiển thị như một phần của khai báo lớp và phải là
mô tả ngắn gọn hợp lý về loại / thành viên. Sử dụng để biết thêm chi tiết
thông tin.

<thông số kiểu chữ name = "NAME"> MÔ TẢ
là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Điều này được sử dụng để mô tả tham số kiểu cho một kiểu chung hoặc phương thức chung.

TÊN là tên của tham số kiểu, trong khi MÔ TẢ chứa một mô tả về
tham số (nó được sử dụng để làm gì, những hạn chế nào mà nó phải đáp ứng, v.v.).
Loại tập hợp cơ bản


Được sử dụng để chỉ ra rằng một từ là một tham số kiểu, để sử dụng trong các khối văn bản khác
(ví dụ như trong ).
Nếu như là một cấu trúc, sau đó ...

SỰ MÔ TẢ
là một phần tử cấp cao nhất và phải được lồng ngay dưới
thành phần.

Cho phép một thuộc tính được mô tả.

MỘT có chứa tên tiện ích con.

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