使用文档生成器Doxygen为c#项目生成文档

最新推荐文章于 2024-03-08 00:14:32 发布
最新推荐文章于 2024-03-08 00:14:32 发布
阅读量952 收藏
点赞数
分类专栏： 工具 文章标签： Doxygen 文档生成器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xx0505/article/details/83892133
版权

一、简介

Doxygen是一种开源跨平台的，以类似JavaDoc（java开发环境自带的API文档生成工具）风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件（根据文件的形成规律和特点,保持文件之间的有机联系,区分不同价值,便于保管和利用的文件整理。）开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

二、功能及特点

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。减轻程序维护负担，添加文件整理负担。

三、安装相关程序

本文使用的为Doxygen 1.8.14

3.1、Doxygen

下载地址：http://sourceforge.net/projects/doxygen/?source=dlp

我们将在配置的时候使用doxywizard，Doxygen的GUI版本。

3.2、HTML Help Workshop

如果你希望你的Doxygen自动生成chm，那么请下载HTML Help Workshop，我们将要使用当中的hcc.exe文件以及相关dll下载地址：

最低0.47元/天 解锁文章
使用Doxygen生成C#帮助文档
weixin_33913377的博客
07-14 280
一． 什么是Doxygen? Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负...
强大的C#API文档生成工具
07-03
Sandcastle是微软官方的文档生成工具，NDoc开发停止后，这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档，支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单，而且SHFB工具看起来很强大，不仅能够直接配置生成文档的各个属性，而且还支持很灵活的扩展设置，为我们提供完美的.NET类库文档成为一个可能。
将C# 类文件中属性和方法自动生成文档，C#类文档结构化生成
12-08
将C# 类文件中属性和方法自动生成文档，C#类文档结构化生成
c#生成文档工具
developingSolver的博客
12-31 424
Sandcastle Help File Builder (SHFB) github:https://github.com/EWSoftware/SHFB
C# 生成Word文档
小鹰信息技术服务部
03-04 3736
C#生成Word文档，实际尝试了一种可行的方法，记录如下： 1. 添加引用 Microsoft.Office.Interop.Word.dll，这个文件有多种版本，我选了11.0的，链接：https://download.csdn.net/download/zhouyingge1104/10992883 2. 组织代码 using Microsoft.Office.Inte...
C#生成Word文档
lancer_eva的专栏
10-18 490
  Normal 0 7.8 磅 0 2 false false false MicrosoftInternetExplorer4 <!-- /* Font
Doxygen文档生成器分享
11-19
Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容
doxygen1.5.5 c++ 文档生成器
09-28
**doxygen 1.5.5 C++ 文档生成器** Doxygen是一款强大的开源文档生成工具，特别适用于C++项目，但同样支持其他多种编程语言。版本1.5.5是该工具的一个历史版本，它能够自动生成项目的API文档，帮助开发者理解和使用...
Doxygen自动化文档生成工具详解
"Doxygen使用指南，自动生成文档工具，C++，C，Java，IDL，PHP，C#，HTML，Latex，RTF，ps，PDF，UnixManpage" Doxygen是一个强大的开源文档生成工具，它能够从源代码中的特定注释格式自动创建文档，支持多种编程...
Doxygen:使用 Doxygen 文档
07-12
5. **运行Doxygen**：使用`make`或`ninja`命令来执行Doxygen，这将根据`Doxyfile`的设置生成文档。 ### 三、注释语法 Doxygen支持一种称为"Javadoc"风格的注释，它以`/**`开始，`*/`结束，可以嵌套在类、函数、...
C# 自动生成word文档
10-13
C# 生成word文档，包括页眉，页码，表格、图片、字体等的编辑
VS c# 生成 文档 注释 源代码
05-07
使用说明：在项目-属性-生成-输出-输出XML文档注释。然后用本软件打开此文档。在datagrid按CTRL+A复制到Word。在word中选择表格-设计-选择任一模板，表格线就变单线了。
c#根据word模板生成word文档
03-04
c#根据word模板生成word文档 附件中包含程序源码以及word模板文件 需要引用的DLL已经在源码中标出
netdoc:NetDoc是用于从C＃代码创建简单API文档的工具
04-28
网络文件 NetDoc是用于从C＃代码创建简单API文档的工具。 安装 该项目使用Node.js作为命令行界面。 请注意，您需要使用0.10。*或更高版本的Node.js。 要安装，请使用npm。 npm install https://github.com/ntotten/netdoc/tarball/master/ -g 用 // Generates docs from a csproj file netdoc <inputPath> <outputPath> example: netdoc .\Source\MyProject.csproj .\docs\ // Create a json document use to generate the docs netdoc json <inputPath> <outputPath> example: netdoc json .\So
csharp-docs-generator:为C＃程序生成html文档以用于GitHub页面的操作
05-06
C＃文档生成器 此操作将为C＃项目生成一个静态html文档。 它将在存储库中创建文档，并在完成生成后将其提交。 注意：此项目将删除在output-path输入下列output-path的文件夹。 这是为了删除不再存在的旧API内容，但是请确保将output-path变量更改为不会不必要地删除文件的目录！ 目录 入门 要开始进行基本设置，请转到将编译代码的每个.csproj文件，并将以下内容添加到PropertyGroup ： < GenerateDocumentationFile>true</ GenerateDocumentationFile> 这将确保将生成用于操作的文档，以用于生成网页。 .csproj文件应如下所示： < Project xss=removed> < PropertyGroup> < TargetFrame
如何在 C# 中生成 PDF
最新发布
TeamDev的博客
03-08 2251
使用 DotNetBrowser 在 C# 中逐步生成 PDF 文件的教程。
C#自定义设计器——文件名选择编辑器
跟健哥出去走走
12-11 3136
C#自定义设计器——文件名选择编辑器        暑期的时候用MCI的一些API封装了一个播放音乐的类，最近学习了GDI+，想着将这个类做成一个自定义的控件，那么在做的过程中有一个属性，如下： public string FileName { get { return fileName; } set { fileName = value; } } pr
C/C++文档注释神器——Doxygen常用知识整理（持续更新）
j6915819的专栏
02-08 4702
C/C++文档注释神器——Doxygen常用知识整理（持续更新） 分类： C++2010-04-14 20:48 772人阅读 评论(0) 收藏 举报 Doxygen是什么 Doxygen 是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语 言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和J
Doxgen的使用
热门推荐
ArenAK－－图形与编程
11-18 2万+
Doxgen是一个文档生成工具，一年前就注意了这个东西，只是一直没用，今晚闲着就把它捡起来，以后写完代码就用它了。Doxgen就是从你的代码中提取注释来生成供用户使用的说明文档，文档可以是各种格式，如html、rtf、xml等，不过我刚刚只是试验了html，感觉很不错。Doxgen很容易上手，不到两个小时的时间已经算初步掌握。利用Doxwizard GUI可以很方便的设置自己所需要的文档效
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值