这是indexloc提供的服务,不要输入任何密码
Skip to content

Add documentation comments to user-facing rust and typescript code #727

@jacobhq

Description

@jacobhq

Add inline documentation to the user exposed functions/struct/anything.

This would help a lot of the users by improving code editor inline suggestions + llm contexts.

  • JSDoc comments in typescript
/**
 * Here my comment
 */
function myFunction() {}
  • Documentation comments in rust
/// Three slashes comment
fn my_function(){}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions