三把利器快速制作代码帮助文档

简介: 1、前言相信不少麻油都已经积累了属于自己的代码库了,不知道是否有过这样的经历:A:听说你上次写了个通用XXX类库啊,我正好要用到,麻烦把dll发我一下。B:好的,你等一下,我发给你。。。。
1、前言

相信不少麻油都已经积累了属于自己的代码库了,不知道是否有过这样的经历:



A:听说你上次写了个通用XXX类库啊,我正好要用到,麻烦把dll发我一下。


B:好的,你等一下,我发给你。。。


。。。十分钟后


A:喂,你这个类是怎么用的啊,有没有帮助文档啊。


B:汗,没来得及做,我来和你说吧。。。



一个好用的类库,如果能配上一个好的说明文档(最好还带搜索功能),无疑是为自己和他人提供了莫大的方便,有什么想要的功能,去文档里一查,一目了然。


我最近就碰到了这个问题,甚至更为严重的是,有很多很久之前写的代码,里面实现了哪些功能,细节我已经不是很清楚了,还需要去翻看代码,非常难管理和查找。


2、准备

那么开始今天的内容,首先需要准备好三大利器啊^_^:



一、下载安装GhostDoc:http://submain.com/download/ghostdoc/


二、下载安装sandcastlehttp://sandcastle.codeplex.com/和Sandcastle Help File Builderhttp://shfb.codeplex.com/


三、安装Visual Studio(什么?这个谁没有?好吧,咱们继续往下-
-||)


3、开始

下面说一下三大利器到底怎么配合用,帮我们制造出好用的帮助文档呢?


一、给代码添加XML注释

不知道大家通常是怎么写注释的,我的习惯都是直接///然后vs帮我生成XML格式的注释,而不是简单的//或者/**/。现在有了GhostDoc(大家也可以下载GhostDoc
Pro,可以批量注释,更强大),我们就可以快速的给我们的代码添加注释了。


这一步是必不可少的,否则文档就没有了数据来源了。


如果GhostDoc不会用,可以参考这个文章,总结的很详细:http://www.cnblogs.com/RockyMyx/archive/2010/04/20/Project-Route-Using-GhostDoc.html


二、整理项目文件

这一步是做什么呢?其实主要是利用VS强大的“生成后事件”功能,配置一些宏和Marco指令,把我们代码库中的dll和注释文件xml拷贝到一起,方便制作。当然,如果您的代码全写在一个项目dll里,那这一步对您来说是没什么用处啦。反正我的库是分了20多个项目,一个个去找dll很麻烦的,所以就自动让他们放到一个输出目录下:


打开项目属性:


image


选择“生成”面板,允许输出XML注释文档,这步很重要


image


下面选择“生成事件”面板,在“生成后事件”中输入指令:



copy  "$(TargetDir)*.dll"
"$(TargetDir)..\..\..\OutPut"
copy  "$(TargetDir)*.xml"
"$(TargetDir)..\..\..\OutPut"



好了,把整个类库重新生成一下,会发现在OutPut文件夹里全部是我们要的dll和Xml:


image


三、使用Sandcastle Help File
Builder建立帮助文档项目

打开Sandcastle Help File Builder,后面的具体步骤可以参考这篇文章:http://www.cnblogs.com/RockyMyx/archive/2010/04/30/Project-Route-Using-SandcastleBuilder.html,也很详细。按照步骤一步步做,就可以成功生成帮助文档了。


4、效果

下面看一下效果:


image


目录
相关文章
|
9天前
|
人工智能 数据可视化 安全
王炸组合!阿里云 OpenClaw X 飞书 CLI,开启 Agent 基建狂潮!(附带免费使用6个月服务器)
本文详解如何用阿里云Lighthouse一键部署OpenClaw,结合飞书CLI等工具,让AI真正“动手”——自动群发、生成科研日报、整理知识库。核心理念:未来软件应为AI而生,CLI即AI的“手脚”,实现高效、安全、可控的智能自动化。
34524 25
王炸组合!阿里云 OpenClaw X 飞书 CLI,开启 Agent 基建狂潮!(附带免费使用6个月服务器)
|
20天前
|
人工智能 JSON 机器人
让龙虾成为你的“公众号分身” | 阿里云服务器玩Openclaw
本文带你零成本玩转OpenClaw:学生认证白嫖6个月阿里云服务器,手把手配置飞书机器人、接入免费/高性价比AI模型(NVIDIA/通义),并打造微信公众号“全自动分身”——实时抓热榜、AI选题拆解、一键发布草稿,5分钟完成热点→文章全流程!
45383 147
让龙虾成为你的“公众号分身” | 阿里云服务器玩Openclaw
|
3天前
|
人工智能 自然语言处理 安全
Claude Code 全攻略:命令大全 + 实战工作流(建议收藏)
本文介绍了Claude Code终端AI助手的使用指南,主要内容包括:1)常用命令如版本查看、项目启动和更新;2)三种工作模式切换及界面说明;3)核心功能指令速查表,包含初始化、压缩对话、清除历史等操作;4)详细解析了/init、/help、/clear、/compact、/memory等关键命令的使用场景和语法。文章通过丰富的界面截图和场景示例,帮助开发者快速掌握如何通过命令行和交互界面高效使用Claude Code进行项目开发,特别强调了CLAUDE.md文件作为项目知识库的核心作用。
3472 12
Claude Code 全攻略:命令大全 + 实战工作流(建议收藏)
|
1天前
|
人工智能 供应链 安全
|
1天前
|
人工智能 机器人 开发工具
Windows 也能跑 Hermes Agent!完整安装教程 + 飞书接入,全程避坑
Hermes Agent 是一款自学习AI智能体系统,支持一键安装与飞书深度集成。本教程详解Windows下从零部署全流程,涵盖依赖自动安装、模型配置、飞书机器人接入及四大典型兼容性问题修复,助你快速构建企业级AI协作平台。(239字)
1979 9
|
10天前
|
人工智能 JSON 监控
Claude Code 源码泄露:一份价值亿元的 AI 工程公开课
我以为顶级 AI 产品的护城河是模型。读完这 51.2 万行泄露的源码,我发现自己错了。
5049 21
|
2天前
|
人工智能 监控 安全
阿里云SASE 2.0升级,全方位监控Agent办公安全
AI Agent办公场景的“安全底座”
1141 1
|
3天前
|
机器学习/深度学习 存储 人工智能
还在手写Skill?hermes-agent 让 Agent 自己进化能力
Hermes-agent 是 GitHub 23k+ Star 的开源项目,突破传统 Agent 依赖人工编写Aegnt Skill 的瓶颈,首创“自我进化”机制:通过失败→反思→自动生成技能→持续优化的闭环,让 Agent 在实践中自主构建、更新技能库,持续自我改进。
738 2

热门文章

最新文章