跳到主要内容

Documentation Window / 文档窗口

源文档地址

用文档窗口可以给你的各种元素写说明。按 Ctrl + M 打开它,顶部的三个下拉框用来导航:

  • 文档
  • 所选文档里的草图
  • 所选草图里的运算器

只要 Attach 复选框没有勾上,你在编辑器里切换草图时,文档窗口就会跟着当前草图走。

文档窗口

写说明这件事,主要在你准备把节点库分享给别人时才有意义。做自己的项目时基本用不上。

Document / 文档

  • Summary:一句话描述这个文档的内容
  • Authors:作者
  • Credits:致谢
  • License URL:许可证地址
  • Project URL:项目地址

Datatype / 数据类型

  • Summary:一句话描述这个数据类型
  • Remarks:补充的用法说明、注意事项、已知问题等
  • Tags:逗号分隔的标签,用来在节点浏览器里找到这个数据类型
  • Properties:逐个描述这个数据类型的每个参数

Operation / 运算器

  • Summary:一句话描述这个运算器
  • Remarks:补充的用法说明、注意事项、已知问题等
  • Tags:逗号分隔的标签,用来在节点浏览器里找到这个运算器
  • Inputs:逐个描述这个运算器的每个输入
  • Outputs:逐个描述这个运算器的每个输出