Có cách nào để tạo tài liệu dự án trong quá trình xây dựng tự động không?Tạo tài liệu trong tự động xây dựng
Tôi muốn có một bộ duy nhất của các tập tin nguồn (HTML?) Với các hướng dẫn sử dụng, và từ họ generate:
Nội dung về cơ bản giống nhau ở cả ba định dạng.
Hiện tại tôi đang sử dụng msbuild và CCNET, nhưng tôi có thể thay đổi điều đó nếu cần.
Có!
Họ có thể dễ dàng tích hợp với CruiseControl.NET qua NAnt.
Dự án Apache Forrest có thể đi một số cách để cung cấp cho bạn những gì bạn muốn.
Nói chung, bạn nên viết tài liệu của mình bằng XML. Từ đó bạn nên có khả năng tạo ra bất cứ thứ gì bạn cần.
Bạn đã thử Doxygen? Nó có sẵn cho Windows và nó sẽ được dễ dàng để tích hợp nó trong bất kỳ kịch bản xây dựng/quá trình.
Trợ giúp và thủ công có thể tạo ra các định dạng PDF, HTML và CHM chất lượng tốt (và các định dạng khác) từ một nguồn duy nhất. Nó cũng có một giao diện dòng lệnh. Tôi có phiên bản 4 và tôi rất thích nó. Tôi sử dụng điều kiện (như #ifdefs) để tạo phiên bản Windows và Mac của tài liệu của tôi ở các định dạng khác nhau như một phần của tệp .bat/.csh xây dựng. Phiên bản 5 hiện khả dụng.
Nếu bạn muốn api của bạn tài liệu quá, và bạn đang sử dụng msbuild, sau đó xem xét sử dụng DocProject để kiểm soát SandCastle xây dựng. (Những công cụ này không dành cho tài liệu người dùng cuối ...)
Tôi đã có kinh nghiệm với Doxygen. Nó là tốt đẹp và dễ dàng, nhưng nó làm cho bạn muốn overcommenting mã để dễ dàng làm việc sau này documetation.