Documenter.jl如何忽略指定docstring消除未收录警告

使用Documenter.jl构建文档时，未在手册中引用的docstring会触发not included in the manual警告，针对不需要导出到公开文档的内部方法docstring，可通过以下两种方式实现单个/批量忽略：

• 方式一：在目标docstring内添加隐藏标记
  直接在不需要导出的docstring内容头部加入# hide标识，Documenter扫描时会自动跳过该docstring的校验，也不会将其渲染到最终生成的文档站点中，写法示例：

  """
    r_xml_travel!(xml, xpath_str, res_vec)
  
  内部XML遍历工具函数，不对外提供公开接口
  # hide
  """
  function r_xml_travel!(...)
      # 函数逻辑实现
  end
  

  这种方式适合零散的、确定不需要公开的内部方法，直接在源码层面标记，后续维护时也能直观看到该docstring不会被导出。

• 方式二：在文档构建配置中添加过滤规则
  如果不想改动源码内的docstring内容，可以在构建脚本的makedocs配置项中通过docsfilter参数自定义过滤逻辑，匹配到规则的docstring会直接跳过存在性校验，示例配置：

  makedocs(
      # 原有配置（sitename、format、pages等）保持不变
      docsfilter = doc -> begin
          # 忽略指定的内部方法
          b = doc.bindings[1]
          if b.var == :r_xml_travel! && b.mod == ProtoSyn.Calculators.TorchANI
              return false
          end
          # 忽略针对Base类型的扩展方法docstring
          if b.mod == Base
              return false
          end
          # 其余docstring正常纳入校验
          return true
      end
  )
  

  这种方式适合批量过滤某一类不需要导出的docstring，配置逻辑都集中在文档构建脚本里，不会侵入业务源码。

注意：不要直接全局关闭docstring缺失警告，否则会漏掉真正需要导出、但忘记在手册中引用的公开API文档。

内容的提问来源于stack exchange，提问作者Zé Manel