2008-09-09 11 views
19

Tôi luôn luôn viết một ý kiến ​​viết mã đẹp cho các lớp và phương thức với cú pháp C# xml. Tôi luôn mong muốn có thể dễ dàng xuất chúng sau này.Làm cách nào để xuất tài liệu mã trong C#/VisualStudio 2008?

Hôm nay tôi thực sự phải làm như vậy, nhưng gặp sự cố khi tìm hiểu cách thực hiện. Có cái gì tôi đang mất tích? Tôi muốn đi Menu-> Xây dựng-> Xây dựng Tài liệu Mã số, nhưng không có tùy chọn để làm điều đó, ở đó.

+0

_OP đã nối thêm đề xuất này: _ Liên kết này có xslt dễ dàng để xuất nhanh chóng và bẩn: http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx – Mogsdad

Trả lời

24

Thực ra nó nằm trong thuộc tính dự án. Tab xây dựng, phần Đầu ra, tệp tài liệu XML và nhập tên tệp. Nó sẽ được xây dựng trên mọi bản dựng của dự án.

Sau đó, bạn có thể tạo trợ giúp thực tế với Sandcastle.

+0

Bạn vẫn có thể viết XSL/XSLT để định dạng XML thành một kết quả đẹp hơn. – Biri

4

Bạn có thể thử NDOC hoặc SandCastle nếu bạn không nhớ sử dụng các công cụ của bên thứ 3.

+0

Trong khi liên kết này có thể trả lời câu hỏi, nó là tốt hơn để bao gồm các phần thiết yếu của câu trả lời ở đây và cung cấp liên kết để tham khảo. Câu trả lời chỉ liên kết có thể trở thành không hợp lệ nếu trang được liên kết thay đổi. - [Từ đánh giá] (/ review/low-quality-posts/18546091) – Nae

1

Sandcastle hoạt động khá tốt để tạo tài liệu và nó hỗ trợ một vài định dạng khác nhau cho thế hệ. Theo như tôi biết, không có bất kỳ tích hợp Visual Studio cho nó, nhưng có một SandcastleGUI cho nó có sẵn.

1

Hãy cẩn thận nếu bạn đang sử dụng LINQ to SQL vì bạn sẽ không thể dễ dàng thêm nhận xét bền vững cho các đối tượng được tạo tự động.

0

Dự án NDoc gốc (được người khác đề cập) đã chết, nhưng có một dự án mới có tên là NDoc3.

NDoc3 hỗ trợ .NET 2.0 - 3.5. Nó hiện đang có sẵn như là một phiên bản beta và làm việc tuyệt vời cho tôi. Tôi không chắc liệu dự án có còn hoạt động hay không - bản beta cuối cùng đã được phát hành vào tháng 4 năm 2009.

1

Nhận xét muộn, nhưng đáng giá thêm rằng mặc dù Sandcastle bị mothballed, Sandcastle Help File Builder vẫn hoạt động tích cực. mạnh mẽ và đơn giản để đi sâu vào khi đối phó với tình huống này - cài đặt vào đầu ra rich .chm và .html/.asp trong vài giờ.