2011-11-30 40 views
8

Tôi đã thử Sandcastle với các bản vá kèm theo cài đặt GUI có hướng dẫn, nhưng trừ khi tôi đang làm điều gì đó sai, về cơ bản không phù hợp cho việc viết tư liệu mã F # (ngay cả khi nó hoạt động tốt cho C#). Có lẽ nó hoạt động cho những người khác, trong trường hợp này tôi sẽ rất biết ơn một ví dụ ngắn hoàn chỉnh mà tôi có thể bắt đầu từ đó. Cảm ơn nhiều.Cách tốt nhất để ghi lại mã f # là gì?

Tôi biết về Sandcastle doesn't output everything from a F# assembly, nhưng dự án được tham chiếu ở đó chưa xuất hiện sẵn sàng cho thời gian chính.

Chắc chắn phải có điều gì đó hoạt động đáng tin cậy và là "đủ tốt"? Cảm ơn rất nhiều về sựh gợi ý.

Chỉnh sửa: Rất cảm ơn mọi người đã trả lời. Câu trả lời của Brian là gần nhất với những gì tôi muốn, vì vậy tôi sẽ chấp nhận nó. Tuy nhiên, kết quả là có vẻ như không phải là một giải pháp vừa phù hợp với F # và hoạt động đáng tin cậy. Tôi sẽ gắn bó với các bình luận văn bản ngay bây giờ.

Tôi hy vọng FsHtmlDoc.exe sẽ bắt đầu hoạt động tại một số điểm. Trong khi tôi không thể loại trừ rằng nó hoạt động đã được và tôi chỉ không sử dụng nó một cách chính xác, googling nó cho thấy tôi không phải là người duy nhất để tìm thấy nó là chưa hoàn hảo.

Trả lời

3

Tôi biết bên cạnh không có gì về Sandcastle, nhưng lưu ý rằng như C#, trong F # bạn có thể sử dụng chú thích ba dấu gạch chéo và chúng sẽ xuất ra trong tệp tài liệu XML mà trình biên dịch xuất (trong VS, trên thuộc tính dự án trang, xây dựng tab, đánh dấu vào hộp kiểm 'Xml tài liệu tập tin'; trên dòng lệnh, sử dụng --doc lập luận để fsc.exe)

Ngoài ra, xem FsHtmlDoc.exe trong PowerPack..

+0

Rất cám ơn. Thật không may, tôi dường như đã đi lên chống lại http://fsharppowerpack.codeplex.com/workitem/6375# (mặc dù nó rất có thể dễ dàng được rằng cả tôi và bất cứ ai báo cáo lỗi làm điều gì đó sai) – user1002059

2

Bạn cũng có thể nhìn vào Focco

Nó tạo ra một tài liệu html đẹp dựa. Xem here để biết ví dụ:

+0

Rất cám ơn. Tôi có thể chưa sử dụng nó, tuy nhiên tôi đã thực sự hy vọng tìm thấy một cái gì đó mà tài liệu các loại đối số bằng cách sử dụng sự phản ánh. – user1002059

1

Bạn cũng có thể xem ApiStack từ IntelliFactory. Tôi nhận ra Focco yêu cầu một cách tiếp cận rất khác nếu bạn đã có rất nhiều bình luận về tài liệu XML chuẩn.

+0

Rất cám ơn. Rất tiếc, tôi không được phép xuất bản mã nguồn. – user1002059

0

Tôi chưa sử dụng, nhưng có thể đáng để thử docu một lần thử ...

Các vấn đề liên quan