C#项目程序员文档自动生成-----Sandcastle
2017-12-27 17:23
148 查看
这几天由于需求,需要生成C#项目的程序员帮助文档,顺便了解了一下网上使用比较多的方式,例如Doxygen和Sandcastle,此处就使用Sandcastle方式进行演示生成C#项目程序员帮助文档。
第一步,从官网下载Sandcastle软件
下载地址 : http://sandcastle.codeplex.com/
第二步,安装Sandcastle
将下载后的压缩文件解压,双击安装
一路next
这块要注意点,先将依赖的package安装再继续next,直到安装完成
第三步:使用Sandcastle,运行安装好的Sandcastle进入主页面
建立一个新项目
点击保存后进行详细操作
不过在使用Sandcastle得注意一点,该软件是通过VS中的本地注释生成的,所以代码上的注释必须要添加,否则意义不是很大!!!
以上就是Sandcastle的简单使用
第一步,从官网下载Sandcastle软件
下载地址 : http://sandcastle.codeplex.com/
第二步,安装Sandcastle
将下载后的压缩文件解压,双击安装
一路next
这块要注意点,先将依赖的package安装再继续next,直到安装完成
第三步:使用Sandcastle,运行安装好的Sandcastle进入主页面
建立一个新项目
点击保存后进行详细操作
不过在使用Sandcastle得注意一点,该软件是通过VS中的本地注释生成的,所以代码上的注释必须要添加,否则意义不是很大!!!
以上就是Sandcastle的简单使用
相关文章推荐
- .NET1.1下,使用C#自动生成Word2003文档(通过操作COM组件实现)
- Sandcastle----强大的C#文档生成工具
- 【项目学习】——C#自动生成错误日志
- MFC:“Debug Assertion Failed!” ——自动生成的单文档程序项目编译运行就有错误
- MFC:“Debug Assertion Failed!” ——自动生成的单文档程序项目编译运行就有错误
- 百度地图和高德地图坐标系的互相转换 四种Sandcastle方法生成c#.net帮助类帮助文档 文档API生成神器SandCastle使用心得 ASP.NET Core
- Sandcastle----强大的C#文档生成工具
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- Sandcastle生成项目文档
- 四种Sandcastle方法生成c#.net帮助类帮助文档
- .NET1.1下,使用C#自动生成Word2003文档(通过操作COM组件实现)
- 用Sandcastle生成.net项目API文档
- Sandcastle----强大的C#文档生成工具
- IOS项目自动生成技术文档
- vs2010代码注释自动生成api文档(Sandcastle帮助文档生成器使用介绍)
- .NET1.1下,使用C#自动生成Word2003文档(通过操作COM组件实现)
- iOS开发项目自动生成技术文档
- iOS开发----IOS项目自动生成技术文档
- Sandcastle:开源C#文档生成工具(也可用于其他语言)
- iOS开发项目自动生成技术文档