实例介绍
DotNetOMDGenerator是一个强大的跨平台工具,基于Roslyn技术,专为C#开发者和.NET程序集设计,能够自动从一系列的源代码文件或编译后的程序集中生成清晰的对象模型图。
安装方法非常简单,只需通过命令行运行以下命令(需要已安装.NET Core 2.1):
dotnet tool install --global dotMorten.OmdGenerator
使用方法也非常灵活:
generateomd /source=[源文件夹] /compareSource=[旧源文件夹] /preprocessors=[定义] /format=[html|image] /showPrivate /showInternal
无论是希望生成整个项目的对象模型图,还是对比不同版本间的API变化,dotMorten都能提供强大的支持。此外,还可以通过NuGet包将其集成到您的类库项目中,进一步自动化您的文档生成流程。
例如,要为.NET Core FX源代码生成OMD并忽略ref和test文件夹,可以使用以下命令:
generateomd /source=c:\github\dotnet\corefx\src /exclude="*/ref/*;*/tests/*;*/perftests/*"
这个工具不仅适用于开发者个人项目的文档化工作,也适合团队协作中的API变更跟踪,是每位C#开发者和.NET程序集维护者的必备工具。
【实例截图】
文件清单
└── DotNetOMDGenerator-1a3ad975a60d9431d5f5aeac237dde9364558553
├── LICENSE
├── README.md
├── Screenshot.png
├── src
│ ├── Generator
│ │ ├── ArgumentParser.cs
│ │ ├── dotMorten.OmdGenerator.targets
│ │ ├── Generator.csproj
│ │ ├── Generators
│ │ │ ├── HtmlOmdFooter.html
│ │ │ ├── HtmlOmdGenerator.cs
│ │ │ ├── HtmlOmdHeader.html
│ │ │ ├── MarkdownGenerator.cs
│ │ │ └── OMDGenerator.cs
│ │ ├── ICodeGenerator.cs
│ │ ├── Program.cs
│ │ ├── Properties
│ │ │ └── launchSettings.json
│ │ ├── TypeExtensions.cs
│ │ └── WorkspaceHelper.cs
│ └── Generator.sln
└── TestCode
├── NewCode
│ ├── Class1.cs
│ ├── Enum1.cs
│ ├── Interface1.cs
│ ├── NmeaParser.dll
│ └── NmeaParser.xml
└── OldCode
├── Class1.cs
├── Enum1.cs
├── Interface1.cs
├── NmeaParser.dll
└── NmeaParser.xml
8 directories, 27 files
标签:
小贴士
感谢您为本站写下的评论,您的评论对其它用户来说具有重要的参考价值,所以请认真填写。
- 类似“顶”、“沙发”之类没有营养的文字,对勤劳贡献的楼主来说是令人沮丧的反馈信息。
- 相信您也不想看到一排文字/表情墙,所以请不要反馈意义不大的重复字符,也请尽量不要纯表情的回复。
- 提问之前请再仔细看一遍楼主的说明,或许是您遗漏了。
- 请勿到处挖坑绊人、招贴广告。既占空间让人厌烦,又没人会搭理,于人于己都无利。
关于好例子网
本站旨在为广大IT学习爱好者提供一个非营利性互相学习交流分享平台。本站所有资源都可以被免费获取学习研究。本站资源来自网友分享,对搜索内容的合法性不具有预见性、识别性、控制性,仅供学习研究,请务必在下载后24小时内给予删除,不得用于其他任何用途,否则后果自负。基于互联网的特殊性,平台无法对用户传输的作品、信息、内容的权属或合法性、安全性、合规性、真实性、科学性、完整权、有效性等进行实质审查;无论平台是否已进行审查,用户均应自行承担因其传输的作品、信息、内容而可能或已经产生的侵权或权属纠纷等法律责任。本站所有资源不代表本站的观点或立场,基于网友分享,根据中国法律《信息网络传播权保护条例》第二十二与二十三条之规定,若资源存在侵权或相关问题请联系本站客服人员,点此联系我们。关于更多版权及免责申明参见 版权及免责申明
网友评论
我要评论