Gonzalo cung cấp tổng quan tốt về các mô-đun khác nhau.
Vì bạn cũng đã đề cập muốn đóng góp vào tài liệu, bạn sẽ muốn thêm một vài thông tin nữa.
Đầu tiên, Tài liệu được lưu trữ trong các tệp XML trong vòng mcs/lớp/[assembly]/Tài liệu/, ví dụ: mcs/class/corlib/Documentation. Mục đích là để hỗ trợ nhiều ngôn ngữ của con người (mặc dù chỉ có tiếng Anh hiện đang được thực hiện), vì vậy trong vòng Tài liệu là một thư mục ngôn ngữ, thường là en
. Trong phạm vi en
có các tệp ns-*.xml
, ví dụ: mcs/class/corlib/Documentation/en/ns-System.xml chứa tài liệu cho không gian tên System
. Cũng trong các thư mục en
là các thư mục "không gian tên phân tán" và trong đó là các tệp XML, một tệp cho mỗi loại, ví dụ: mcs/class/corlib/Documentation/en/System.Collections.Generic/IEnumerable`1.xml.
Điều này cũng được nêu trong tài liệu mdoc(5), trong phần FILE/DIRECTORY STRUCTURE
.
Khi bạn đã tìm thấy tài liệu, bạn cần biết định dạng XML, cũng được mô tả trong tài liệu mdoc(5), trong phần NamespaceName/TypeName.xml File Format
. Phương ngữ XML được sử dụng là một biến thể của ECMA 335XML documentation, được thay đổi thành có một tệp cho mỗi loại (thay vì tất cả các loại trong một tệp nguyên khối duy nhất). Đây cũng là một bộ siêu của C# XML documentation (xem Annex E. Documentation Comments
, trang 487).
Cuối cùng, có câu hỏi về việc thêm các loại/thành viên mới vào thư mục mcs/class/[assembly]/Tài liệu. Nếu bạn đã xây dựng Mono, bạn có thể sử dụng mục tiêu Makefile doc-update
.Thao tác này sẽ chạy hội đồng thích hợp thông qua mdoc(1) và cập nhật các tệp thích hợp trong thư mục Tài liệu.
Nếu bạn có bất kỳ câu hỏi nào về tài liệu khác, vui lòng hỏi trên danh sách gửi thư mono-docs-list.
Cảm ơn bạn rất nhiều vì đã mô tả cấu trúc thư mục, bạn có biết liệu có một trang web mô tả điều này không? – markmnl
Có https://github.com/mono/mono/blob/master/README.md – Gonzalo