Multiline API documentation

未关闭

#68 创建于 2019年7月16日 0 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 5/5
预计耗时: 一周以上
新手友好度: 25/100

Issue 类型: 功能
描述清晰度: 需要澄清
活跃度: 停滞
领域: api, documentation

调研方向

该 issue 没有指出源文件或测试。首先检查当前用于方法描述的 ACT IDL 语法，然后确定应如何表示多行元素形式的文档，并验证所选形式能够被接受且保留完整内容。

由索引模型根据 Issue 内容生成。

描述

Documentation for elements in ACT IDL is currently specified like so:

<method name="Frobricate"
        description="An extremely useful method"/>

Having the description as an attribute makes perfect sense, but when writing an IDL file it makes it very hard to provide comprehensive documentation.

It would be nice, for example, to be able to provide documentation in element form also:

<method name="Frobricate"
        ...>
  <description>

    An extremely useful method.

    This is an implementation of Fred Frobricator's notion of _Frobrication_, introduced in
    the 1867 paper 'On Frobrication', of which you can find a copy here:

        https://www.en.wikipedia.org/wiki/Frobrication

  </description>
</method>

(Also happy with any other solution that allows for documentation in a similar for to my example, be it a different syntax for specifying an attribute of which I am unaware, special comments, or whatever.)

主要语言: Go
星标: 54
派生: 26
PR 合并指标: 30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

Autodesk/AutomaticComponentToolkit 的其他 Issue

Python binding: Avoid using globals in Base.__del__() 未关闭

Autodesk/AutomaticComponentToolkit#226 · 5 条评论 · 3 个 reaction · 已指派 3 人 · 2025年7月17日创建
Clarify the meaning of "dynamic" for bindings 未关闭

难度 2/5 1-3 小时新手友好度 45/100

Autodesk/AutomaticComponentToolkit#213 · 1 条评论 · 2 个 reaction · 2024年12月5日创建
XML namespaces are not observed 未关闭

难度 3/5 1-2 天新手友好度 35/100

Autodesk/AutomaticComponentToolkit#188 · 1 条评论 · 2023年7月4日创建
Why isn't JNI already a target? 未关闭

难度 5/5 一周以上新手友好度 20/100

Autodesk/AutomaticComponentToolkit#183 · 1 条评论 · 2023年1月14日创建
stringoutclass issues 未关闭

Autodesk/AutomaticComponentToolkit#162 · 1 个 reaction · 已指派 2 人 · 2021年8月17日创建

查看 Autodesk/AutomaticComponentToolkit 的全部 Issue

相似的 Issue

OOMs triggered by `GoLink` actions taking up to 10 times Bazel's default 未关闭

难度 2/5 1-3 小时新手友好度 76/100

bazel-contrib/rules_go#4726 · 1 条评论 · 2026年9月25日创建
[GEP-38] Create plutono panels to display the volume usage and utilization metrics similar to what we have for CPU and Memory 未关闭

area/auto-scaling area/monitoring area/ops-productivity kind/enhancement

难度 2/5 1-3 小时新手友好度 74/100

gardener/gardener#15814 · 2026年9月25日创建
update: nil context panics while restarting the daemon after a successful update 未关闭

难度 2/5 1-3 小时新手友好度 78/100

kenn-io/msgvault#940 · 2026年9月25日创建
docs(readme): use make setup for first-time local setup 未关闭

Type/Improvement

难度 1/5 1-3 小时新手友好度 90/100

OpenNSW/nsw-srilanka#522 · 2026年9月25日创建
`docker context export` writes a truncated tar archive 未关闭

难度 2/5 1-3 小时新手友好度 92/100

docker/cli#7332 · 2026年9月25日创建

更多 Go Issue