7
7
8
8
** README.md 版本修订历史**
9
9
10
- | 版本 | 提交 | 备注 |
11
- | --------| ------ | ---------|
10
+ | 版本 | 提交 | 备注 |
11
+ | --------| ------ | -----------------------------------|
12
+ | 1.1 | [ e73b4fe] ( https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/e73b4feed9cd261271eb990a9c859f53536e8d7c ) | 新增 "-excludeUmlBeginEndTags" 参数选项 |
12
13
| 1.0 | [ 70bb820] ( https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/70bb8202f7f489aa2d85ce9c25c58121c8f63aed ) | 因为其它语言的README.md不一定同时更新,所以需要一个版本号 |
13
14
15
+ ## Roslyn Source Generator
16
+ 类图由 Roslyn 源代码生成器自动生成。详细信息请参见以下链接。
17
+ - [ PlantUmlClassDiagramGenerator.SourceGenerator] ( /src/PlantUmlClassDiagramGenerator.SourceGenerator )
18
+
14
19
## Visual Studio Code 扩展
15
20
16
21
- [ C# to PlantUML] ( https://marketplace.visualstudio.com/items?itemName=pierre3.csharp-to-plantuml )
20
25
Nuget Gallery: https://www.nuget.org/packages/PlantUmlClassDiagramGenerator
21
26
22
27
### 安装
23
- 下载并安装[ .NET 6 .0 SDK] ( https://www.microsoft.com/net/download/windows ) 或更新的版本。安装后,运行以下命令。
28
+ 下载并安装[ .NET 8 .0 SDK] ( https://www.microsoft.com/net/download/windows ) 或更新的版本。安装后,运行以下命令。
24
29
25
30
``` bat
26
31
dotnet tool install --global PlantUmlClassDiagramGenerator
@@ -39,10 +44,12 @@ puml-gen InputPath [OutputPath] [-dir] [-public | -ignore IgnoreAccessibilities]
39
44
- -public: (可选) 如果指定,只输出公共可及性成员。
40
45
- -ignore: (可选) 指定要忽略的成员的可访问性,用逗号分隔的列表。
41
46
- -excludePaths: (可选) 指定排除的文件和目录。
42
- 指定来自 "InputPath "的相对路径,用逗号分隔的列表。
47
+ 指定来自 "InputPath "的相对路径,用逗号分隔的列表。
48
+ 要排除包含特定文件夹名称的多个路径,请在名称前加上 "\*\* /"。示例:"** /bin"
43
49
- -createAssociation: (可选) 从字段和属性的引用中创建对象关联。
44
50
- -allInOne: (可选) 只有当-dir被设置时:将所有图表的输出复制到文件include.puml(这允许PlanUMLServer渲染)。
45
51
- -attributeRequired: (可选) 当这个开关被启用时,只有类型声明中带有 "PlantUmlDiagramAttribute "的类型会被输出。
52
+ - -excludeUmlBeginEndTags: (可选)当启用此开关时,它将从 puml 文件中排除 \" @startuml \" 和 \" @enduml \" l 标签。
46
53
47
54
例子:
48
55
``` bat
@@ -66,7 +73,7 @@ puml-gen C:\Source\App1 C:\PlantUml\App1 -dir -excludePaths bin,obj,Properties
66
73
| C# | PlantUML |
67
74
| :----------------| -------------------:|
68
75
| ` class ` | ` class ` |
69
- | ` struct ` | ` << struct>> class ` |
76
+ | ` struct ` | ` struct ` |
70
77
| ` interface ` | ` interface ` |
71
78
| ` enum ` | ` enum ` |
72
79
| ` record ` | ` <<record>> class ` |
@@ -75,7 +82,7 @@ puml-gen C:\Source\App1 C:\PlantUml\App1 -dir -excludePaths bin,obj,Properties
75
82
76
83
| C# | PlantUML |
77
84
| :----------------| -------------------:|
78
- | ` abstract ` | ` abstract ` |
85
+ | ` abstract ` | ` abstract ` |
79
86
| ` static ` | ` <<static>> ` |
80
87
| ` partial ` | ` <<partial>> ` |
81
88
| ` sealed ` | ` <<sealed>> ` |
@@ -109,7 +116,7 @@ enum EnumType{
109
116
@startuml
110
117
class ClassA {
111
118
}
112
- class StructA <<struct>> {
119
+ struct StructA {
113
120
}
114
121
interface InterfaceA {
115
122
}
0 commit comments