【发布时间】:2020-04-07 11:43:52
【问题描述】:
如何获得带有详细描述的函数定义?
帮助部分 (F1) 告诉我存在哪些功能,但描述对我来说不够详细。他们没有指定可选参数,也没有解释参数或函数具体做什么:
void ComponentSetFillMode( Component comp, Number mode )设置图像文档组件的填充模式。
文档没有说明允许哪个 mode 以及每个 mode 做什么。
void TextAnnotationSetFixedPoint( Component comp, Number x, Number y )设置文本注释的固定点。
同样没有关于“固定点”是什么的信息。另外通过尝试,我无法弄清楚这是做什么的。
Number TagGroupGetTagSize( TagGroup tagGroup, Number index )获取标签的大小。
另一个例子,我花了几个小时尝试不同的(自行生成的)示例,直到我大致了解“大小”是什么(或更好不是)以及如何将其用于我的目的。
帮助部分包含所有功能的摘要,但没有任何参数,说明不充分。我也有其他来源,但它们也没有涵盖所有内容,也不打算作为文档。谷歌搜索只给我一个function summary(似乎已经过时),有时像this post(图1)这样的图片看起来很有趣。
那么有没有什么办法可以得到详细的函数定义呢?是否有(非官方)更详细的文档?
图片 1 - 一张看起来像是来自this post 的详细文档的图片
【问题讨论】:
-
这张特定的图片来自于 2015 年在东京举行的 Gatan 脚本研讨会的一些 DM 脚本课程材料。
-
F1 帮助文档的“问题”的一部分是,它包含“所有”命令或至少许多历史上由开发人员添加以供内部使用但实际上并不适用于一般用户。从历史上看,DM 脚本在很大程度上是服务工程师在不断变化的软件环境中的一种工具。这既解释了语言的灵活性,也解释了它对文档或过时的命令、参数等的随意处理。