如何配置dartdoc生成文档时仅保留方法签名、排除方法体内容

dartdoc默认会展示API对应的源代码，只需要关闭源代码展示开关即可实现只保留方法签名的效果，有两种配置方式：

方式1：命令行临时配置 #

运行生成命令时增加--no-show-source参数即可：

• 新版本Dart SDK（2.16+）：执行 dart doc --no-show-source
• 旧版本独立dartdoc工具：执行 dartdoc --no-show-source

方式2：项目持久化配置 #

在项目根目录创建dartdoc_options.yaml配置文件，添加如下内容即可，后续运行生成命令不需要额外加参数：

dartdoc:
  showSource: false

注意事项 #

• 配置生效后会隐藏所有公开API关联的源代码块，不仅针对方法，类、属性、枚举等成员的源码都会同步隐藏
• 若需要完全隐藏某一个API不在文档中展示，可在该API的文档注释内添加@nodoc注解
• 修改配置后建议先删除已生成的doc目录，再重新运行生成命令，避免缓存导致配置未生效

内容的提问来源于stack exchange，提问作者Safiul Azam