[英]What is the best way of documenting f# code?
我已经尝试过使用引导的GUI安装中包含的补丁的Sandcastle,但除非我做了一些非常错误的事情,否则它基本上不适合记录F#代码(即使它对C#非常有效)。 也许它适用于其他人,在这种情况下,我会非常感谢我可以从一个简短的完整例子开始。 非常感谢。
我知道Sandcastle不会输出F#程序集中的所有内容 ,但是那里引用的项目还没有准备好进入黄金时段。
肯定有一些可靠的工作并且“足够好”的东西? 非常感谢任何建议。
编辑:非常感谢所有回复的人。 布赖恩的回答最接近我想要的,所以我会接受它。 然而,结果是似乎没有一个既适合F#又能可靠运行的解决方案。 我现在会坚持使用文字评论。
我希望FsHtmlDoc.exe在某些时候开始工作。 虽然我不能排除它已经有效但我只是没有正确使用它,谷歌搜索它表明我不是唯一一个发现它还不完美的人。
我对Sandcastle几乎一无所知,但请注意,就像C#一样,在F#中你可以使用三斜杠注释,它们将在编译器输出的XML文档文件中输出(在VS中,在项目属性页面上,构建选项卡) ,检查“XML文档文件”复选框;在命令行上,使用--doc
参数fsc.exe
)。
另外,请参阅PowerPack中的 FsHtmlDoc.exe
。
您还可以从IntelliFactory查看ApiStack 。 如果您已经有很多标准的XML文档注释,我意识到Focco需要一种非常不同的方法。
我没有用它,但是值得尝试一下文档 ...
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.