documentation-generation

5Nhiệt

2Trả lời

Sử dụng Doc-O-Matic (Express) với Delphi

Tôi đang tìm một công cụ để tạo tài liệu mã nguồn Delphi, và tôi muốn thử một cách để Doc-O-Matic Express (miễn phí). Có bất kỳ hướng dẫn cho người mới bắt đầu làm thế nào để sử dụng Doc-O-Matic Expre

28Nhiệt

5Trả lời

C++: Nơi để viết tài liệu mã: trong .cpp hoặc trong tệp .hpp?

Ở đâu thông lệ để viết tài liệu trong mã của các lớp và phương pháp? Bạn có viết các khối tài liệu như vậy ở trên lớp/phương thức tương ứng trong tệp tiêu đề (.hpp) hoặc trong tệp (.cpp) nguồn không?

6Nhiệt

2Trả lời

Sử dụng tài liệu Sphinx làm cách nào tôi có thể chỉ định định dạng hình ảnh png cho các bản dựng HTML và định dạng hình ảnh pdf cho các bản dựng Latex/PDF?

Sử dụng trình tạo tài liệu nhân sư, tôi đang cố gắng sử dụng hình ảnh .png để xây dựng tài liệu HTML và sau đó tôi muốn có hình ảnh .svg được sử dụng cho các bản dựng PDF/LATEx. Bất kỳ ai biết cách "g

8Nhiệt

1Trả lời

Bộ công cụ JSDoc - Cách chỉ định @param và @property trên cùng một dòng

Có cách nào để tránh phải nhập hai dòng riêng biệt cho @property và @param nếu, như trong ví dụ, trên hàm tạo các tham số và thuộc tính có tên giống nhau. /** * Class for representing a point in 2D s

18Nhiệt

4Trả lời

VS2010: Tệp được tạo tự động và tài liệu XML

Đây thực sự chỉ là yêu cầu lại this question asked about Visual Studio 2008. VS2010 có cung cấp bất kỳ tính năng nào để loại bỏ cảnh báo trình biên dịch CS1591 đối với mã được tạo tự động không? CS159

13Nhiệt

1Trả lời

Các công cụ tài liệu cho các API RPC

Có nhiều công cụ tốt cho tài liệu API và mã nguồn (Doxygen, Headerdoc, Sphinx, để đặt tên nhưng một vài). Tuy nhiên, không ai trong số họ xuất hiện đặc biệt giỏi trong việc tạo tài liệu cho các API đư

7Nhiệt

2Trả lời

Tạo tài liệu mã nguồn XMLDoc Delphi

Tôi giả định rằng XML và Delphi Documentation Guidelines đang trở thành tiêu chuẩn không thực tế đối với các nhận xét tài liệu mã nguồn. Điều đó tốt. Điều xấu là tôi không thể tìm thấy bất kỳ trình tạ

12Nhiệt

1Trả lời

Scaladoc [use case]

Tại sao một số mô tả phương pháp trong Scaladoc bắt đầu bằng [use case]? Ví dụ: scala.collection.immutable.StringOps.++ Chỉ là trình giữ chỗ được thay thế trong tương lai?

16Nhiệt

1Trả lời

Google sử dụng trình tạo tài liệu nào?

Google có tài liệu thống nhất về tất cả các apis của nó. Tôi tự hỏi những gì máy phát điện tài liệu nào nó sử dụng và là nó có sẵn để sử dụng công cộng. Nó có TOC tốt và các tính năng khác. Ngoài ra m

6Nhiệt

4Trả lời

Cách tiêu chuẩn để thêm tài liệu vào một hàm JavaScript là gì?

Tôi đang xem tạo tài liệu API cho dự án JavaScript. JavaScript có bất cứ điều gì tương tự như docstring của Python? function add(a, b) { /** Returns the sum of `a` and `b`. */ retu