什么是最好的方式/工具来记录.NET代码 [英] What is the best way / tool to document .NET code

查看:174
本文介绍了什么是最好的方式/工具来记录.NET代码的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

什么是一些好的.NET代码文档工具?



Ghostdocs不是完全免费的; NDoc已停产;现在,微软已经停止了Sandcastle并将其交给Eric Woodruff,微软有没有其他的代码文档工具?



任何免费的文档工具,您可以使用.NET代码的在线文档将很有用。



什么代码您用于.NET代码的文档工具?最好的工具应该是:




  • 免费

  • 易于设置

  • 具有GUI


解决方案

GhostDoc( http://www.roland-weigelt.de/ghostdoc/ )是在代码中编写摘要标签的好工具。



它将查看您正在记录的项目的名称,并尝试找出一个良好的开始描述。这是一个很有用的工具,可以始终记录您的代码。



我的头部名称不是我的头,但是有一些工具可以拉出夏天的标签进入xml和html。这些工具将为您的API制作一个类似MSDN的站点。这是一个非常好的系统,但由开发人员(您)记录您的代码。


What are some good .NET code documentation tools?

Ghostdocs is not entirely free; NDocs has been discontinued; Sphinx is not exactly easy to setup.

Now that Microsoft has discontinued Sandcastle and handed it over to Eric Woodruff, does Microsoft have any other code documentation tool?

Any good documentation tools which are free and you can have online documentation for your .NET code would be useful.

What code documentation tools do you use for your .NET code? Preferably, the tools should be:

  • free
  • easy to setup
  • have a GUI

解决方案

GhostDoc (http://www.roland-weigelt.de/ghostdoc/) is a good tool for writing summary tags in your code.

It will look at your names of the items you are documenting and try to figure out a good starting description. It is a useful tool to start consistently documenting your code.

I don't the names off the top of my head but then there are tools to pull out the summery tags into xml and html. The tools will make an MSDN like site for your API. It is a pretty good system but it is up to the developer (you) to document you code.

这篇关于什么是最好的方式/工具来记录.NET代码的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆