documentation

23Nhiệt

10Trả lời

Tôi hiện đang bắt đầu sử dụng doxygen để ghi lại mã nguồn của mình. Tôi đã nhận thấy rằng cú pháp rất nặng, mỗi khi tôi sửa đổi mã nguồn, tôi cũng cần phải thay đổi nhận xét và tôi thực sự có ấn tượng

7Nhiệt

1Trả lời

Đánh dấu "sử dụng mẫu" trong tài liệu mã số

Cách thực hành tốt nhất về cách sử dụng ví dụ trong tài liệu mã là gì? Có cách nào được tiêu chuẩn hóa không? Với @usage hoặc @notes? Máy phát tài liệu có hỗ trợ điều này không? Tôi biết câu hỏi này n

30Nhiệt

4Trả lời

Làm cách nào để ghi lại mã MATLAB hướng đối tượng?

Tôi đang viết một ứng dụng khá lớn bằng cách sử dụng MATLAB hướng đối tượng và điều này đã khiến tôi suy nghĩ về cách viết mã. Nếu đây là C, tôi sẽ sử dụng Doxygen. Đối với Java, tôi sẽ sử dụng JavaDo

6Nhiệt

4Trả lời

Thay thế các tài liệu python

Tôi đã viết một bộ chuyển đổi đánh dấu epytext thành reST, và bây giờ tôi muốn chuyển đổi tất cả các tài liệu trong toàn bộ thư viện của mình từ epytext sang định dạng reST. Có cách nào thông minh để

5Nhiệt

2Trả lời

Có tài liệu hướng dẫn/tài liệu trợ giúp chuẩn trong Android không?

Tôi đang viết và xuất bản ứng dụng của mình trên Android và muốn cung cấp tài liệu trợ giúp (thủ công) cho người dùng ứng dụng của tôi. Tôi đã thấy các ứng dụng mở các trang web bên ngoài dưới dạng tr

5Nhiệt

1Trả lời

thêm sơ đồ lớp từ VS2008 vào tập tin trợ giúp Sandcastle

Tôi đã tạo sơ đồ lớp cho các dự án của mình trong Visual Studio 2008 Team System và tôi muốn nhúng các sơ đồ này vào tệp .chm Sandcastle của tôi. Tôi tiếp tục tìm kiếm các tài liệu tham khảo cho Drawb

11Nhiệt

5Trả lời

Làm thế nào tôi có thể biểu diễn một ngắt (đối với vi điều khiển) trong một sơ đồ?

Có ai có bất kỳ ví dụ trực quan nào không?

14Nhiệt

5Trả lời

Có sẵn các công cụ phân tích cú pháp DocBlock của PHP không?

Tôi muốn xây dựng một số trang web tài liệu có quy mô nhỏ nhưng được tùy chỉnh cao hơn cho một số dự án. PhpDocumentor là khá lớn nhưng nó rất nặng. Tôi nghĩ về việc cố gắng tinh chỉnh các mẫu cho điề

112Nhiệt

2Trả lời

Điều gì để đặt vào một chuỗi mô-đun python?

Ok, vì vậy tôi đã đọc cả PEP 8 và PEP 257 và tôi đã viết rất nhiều tài liệu về các chức năng và lớp học, nhưng tôi không chắc chắn về những gì nên đi vào một chuỗi tài liệu mô-đun. Tôi đã tìm ra, ở mứ

26Nhiệt

5Trả lời

Làm thế nào để duyệt (không có trình soạn thảo văn bản) .rst tệp?

Trong nhiều dự án django, trong thư mục tài liệu, tôi có thể xem các tệp * .rst: Cách tốt nhất để duyệt qua chúng (không sử dụng trình soạn thảo văn bản)? Có thể tạo HTML không?