documentation-generation

5Nhiệt

2Trả lời

Tham chiếu một phương thức lớp cụ thể với lệnh @see sử dụng Doxygen

Tôi không thể tham chiếu một phương thức lớp cụ thể bằng cách sử dụng lệnh doxygen @see. Giả sử tôi có một lớp Server với một phương pháp bắt đầu như dưới đây @interface Server : NSObject - (void) s

6Nhiệt

1Trả lời

Sandcastle/SHFB. Thêm biểu tượng nền tảng và thông tin phiên bản để giúp các trang tệp

Tôi đang tạo tệp trợ giúp cho thư viện của mình bằng Trình tạo tệp trợ giúp Sandcastle. Thư viện có ba phiên bản (.NET, Silverlight và Windows Phone 7) được xây dựng từ cùng một cơ sở mã. Tôi muốn thê

6Nhiệt

3Trả lời

Định dạng tài liệu nhận xét nào tốt hơn cho JavaScript?

Có bất kỳ định dạng tài liệu nhận xét nào cho JavaScript và bộ xử lý cho định dạng này tạo tài liệu HTML không? Hiện tại tôi đang sử dụng nhận xét xml của VSDoc để cung cấp trợ giúp IntelliSense vào t

5Nhiệt

1Trả lời

Cách tạo javadoc bằng cách sử dụng ubuntu + eclipse vào dự án của tôi

Mã java của tôi đã được nhận xét bằng cách sử dụng/** cấu trúc cho mỗi hàm. Vì vậy, tôi muốn tạo tất cả tài liệu tự động bằng cách sử dụng: Project > Generate javadoc Nhưng theo mặc định, trên eclip

5Nhiệt

1Trả lời

Tại sao ocamldoc thất bại trên các mô-đun không bị ràng buộc?

Dưới đây là một giao diện ví dụ test.mli, nhận xét với ocamldoc kiểu nhận xét: (** ocamldoc module comment *) open MissingModule;; (** ocamldoc function comment *) val test : unit;; Nếu tôi chạy

14Nhiệt

2Trả lời

Làm thế nào để ghi lại các tham số hàm Python với sphinx-apidoc

Tôi đang cố dọn sạch tài liệu mã python của mình và quyết định sử dụng sphinx-doc vì nó có vẻ tốt. Tôi thích làm thế nào tôi có thể tham khảo các lớp học và các phương pháp khác với các thẻ như: :clas

8Nhiệt

2Trả lời

Cách tạo tài liệu cho biến mẫu và phương thức trong Xcode?

Tôi muốn có thể Alt-Click một biến mẫu (hoặc một phương pháp) như là một phần của chương trình tôi đã tạo và đọc mục đích của nó là gì. Thực tế Xcode đang cho tôi biết biến lớp được khai báo tại - là

5Nhiệt

1Trả lời

Tự động tạo tài liệu REST API từ Symfony

Có cách nào dễ dàng để tạo tài liệu cho REST api trực tiếp từ dự án Symfony không?

6Nhiệt

4Trả lời

Làm cách nào để ghi lại tệp makefile?

Có cách nào để viết bình luận "tiêu chuẩn" trong Makefile để sau này đưa chúng vào một chương trình giống như Doxygen để tạo ra một tài liệu hay (HTML hay man) chẳng hạn? Tôi muốn có một cái nhìn tổng

5Nhiệt

1Trả lời

Làm thế nào để tạo ra đầu ra dạng bảng trong reStructuredText mà không sử dụng định dạng bảng RST?

Tôi đang cố di chuyển tài liệu API và lược đồ trình tạo tài liệu độc quyền của chúng sang reStructuredText. Các mảnh cung cấp cho thời gian khó khăn nhất là, chúng ta có một đại diện bảng chi tiết API