能否在PlantUML文本文件中添加非显示注释?
在PlantUML中添加隐藏注释的方法
当然可行,PlantUML提供了两种常用的隐藏注释方式,这些注释仅保留在源文件里,不会被渲染到最终的图表中:
- 单行隐藏注释:使用单引号
'作为开头,整行内容都会被当作注释忽略。示例:
' 这是一条单行注释,不会出现在生成的图表里 Alice -> Bob: 打招呼
- 多行隐藏注释:用
/'作为注释开头,'/作为结尾,中间的所有内容都会被当作隐藏注释,适合大段的说明文字:
/' 这是一段多行隐藏注释 可以写下详细的逻辑说明、修改记录之类的内容 完全不会影响最终生成的图表 '/ Alice -> Bob: 打招呼
需要注意的是,别和PlantUML里的note语法混淆——note是会显示在图表中的标注,而上面两种是纯代码级别的注释,仅在源文件可见。
内容的提问来源于stack exchange,提问作者my_question
相关产品推荐
相关产品推荐

