Ddoc is the embedded documentation

Ddoc is the embedded documentation generator for the D programming language designed by Walter Bright. Its emphasis is on being able to write documentation in code comments in a natural style, minimizing the need for embedded markup and thus improving the legibility of the code comments. It is similar in concept to Doxygen and Javadoc.

Code comments are associated with symbols in the code, and Ddoc uses the semantic and syntactic information available from the D compiler to fill in routine information such as parameters and return types automatically.

The code comments and symbol table information are processed by Ddoc into an internal structured format. Each of these structures corresponds to a template expressed as a macro. The template macros convert the structured format into another set of macros that express the markup. The latter set of markup macros are expanded to produce, by default, HTML.

Both the template macros and the markup macros can be overridden by the user, and can be applied via external files analogous to HTML style sheets. The template macros can be changed to customize the high level formatting, and the markup macros can be altered to produce other output forms such as XML and XHTML.

Kết quả (Việt) 2:

Ddoc là phát tài liệu nhúng cho các ngôn ngữ lập trình D được thiết kế bởi Walter Bright. Nhấn mạnh của nó là về việc có thể để viết tài liệu trong mã ý kiến trong một phong cách tự nhiên, giảm thiểu nhu cầu đánh dấu nhúng và do đó cải thiện rõ ràng của các ý kiến mã. Nó tương tự như khái niệm để Doxygen và Javadoc.

Mã ý kiến có liên quan với các biểu tượng trong các mã, và Ddoc sử dụng các thông tin ngữ nghĩa và cú pháp có sẵn từ trình biên dịch D để điền các thông tin thông thường như các thông số và kiểu trả về tự động.

Các ý kiến mã và thông tin bảng biểu tượng được chế biến bởi Ddoc vào một định dạng cấu trúc nội bộ. Mỗi của những cấu trúc tương ứng với một mẫu thể hiện như là một vĩ mô. Các macro mẫu chuyển đổi các định dạng có cấu trúc thành một tập hợp các macro thể hiện đánh dấu. Tập cuối của macro đánh dấu được mở rộng để sản xuất, theo mặc định, HTML.

Cả macro mẫu và các macro đánh dấu có thể được ghi đè bởi người sử dụng, và có thể được áp dụng thông qua các tập tin bên ngoài tương tự như phong cách trang HTML. Các macro mẫu có thể được thay đổi để tùy chỉnh định dạng cấp cao, và các macro đánh dấu có thể được thay đổi để sản xuất các dạng đầu ra khác như XML và XHTML.