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 Express để tài liệu mã nguồn Delphi (quản lý dự án doc-o-matic, phong cách docblock ưa thích, cú pháp docblock hoàn chỉnh, vv)?Sử dụng Doc-O-Matic (Express) với Delphi
Trong số này page bạn có thể tìm thấy tài liệu có thể hữu ích cho bạn Delphi Documentation Guidelines. Tôi đã sử dụng nguyên tắc này để ghi lại mã nguồn của mình trong số project này.
Đừng bận tâm với cài đặt Doc-o-matic ngay bây giờ. Phiên bản nhanh chỉ là dòng lệnh.
Doc-o-matic hỗ trợ JavaDoc và XMLDoc (hoặc thậm chí là các kiểu nhận xét gốc). Công cụ tự nó sẽ chỉ giúp nếu mã của bạn đã được bình luận, hoặc nếu bạn muốn bình luận trực tiếp bên trong IDE của nó.
Nếu bạn thích Doc XML hoặc javadoc, Doc-O-Matic không hỗ trợ cả hai đều tốt và cả ba phong cách là hỗ trợ khi viết bình luận của nguồn thông qua trình biên tập tích hợp trở lại nguồn.
Chỉ miễn phí cho mục đích phi thương mại. –
Doc-O-Matic là một công cụ thực sự rất tốt nhưng cuối cùng, chất lượng tài liệu của bạn chỉ tốt như những nỗ lực bạn đã đưa vào trong việc bình luận mã của bạn. –
Bạn có thể thử DelphiCodeToDoc (phần mềm mã nguồn mở được viết bằng Delphi). Tạo một dự án đầu tiên chỉ là vài giây. Sau đó, nếu bạn cần thêm tính năng 'chuyên nghiệp', hãy thử Doc-o-matic (VERY mạnh mẽ). http://dephicodetodoc.sourceforge.net/ – TridenT