Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Multiline API documentation

オープン
#68 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Autodesk/AutomaticComponentToolkit のほかの issue

Autodesk/AutomaticComponentToolkit の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。