Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Multiline API documentation

Đang mở
#68 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
api, documentation

Hướng nghiên cứu

Issue không nêu tên tệp nguồn hoặc bài kiểm thử nào. Trước tiên, hãy xem xét cú pháp ACT IDL hiện tại cho phần mô tả phương thức, sau đó xác định tài liệu ở dạng phần tử nhiều dòng nên được biểu diễn như thế nào và xác minh rằng dạng đã chọn được chấp nhận và giữ nguyên toàn bộ nội dung.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.)

Ngôn ngữ chính
Go
Star
54
Fork
26
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Autodesk/AutomaticComponentToolkit

Tất cả issue của Autodesk/AutomaticComponentToolkit

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.