![如果不列出算法,有什么好方法来描述算法?](https://linux22.com/image/356788/%E5%A6%82%E6%9E%9C%E4%B8%8D%E5%88%97%E5%87%BA%E7%AE%97%E6%B3%95%EF%BC%8C%E6%9C%89%E4%BB%80%E4%B9%88%E5%A5%BD%E6%96%B9%E6%B3%95%E6%9D%A5%E6%8F%8F%E8%BF%B0%E7%AE%97%E6%B3%95%EF%BC%9F.png)
假设有某种算法、一段软件代码,甚至是一个计算函数的物理设备,我想描述一下,但是不是列出它或深入其内部工作原理的细节(因此,我不需要像 和朋友这样的东西algorithm2e
)algorithmic
。我想要列出的是名称、参数、它们的数据类型、它们中的哪些是 in、out 还是 in-out、它们的相对长度可能是多少、默认值、返回值、异常条件或输入要求以及可能还有一些更多信息。从某种意义上说,它有点类似于 doxygen - 但不是从源代码注释生成的。
我该怎么做?自己设计一些东西?有没有一些足够接近实际执行此操作的软件包?
笔记:这不是画图。不涉及节点或箭头。