Skip to content

Proposal - @ai tag #268

Description

@halvardssm

Proposal for new @ai jsdoc tag

I would like to propose an @ai tag that can be used to document if and how an AI has been used in the code.

I would suggest to have two standard options and allow for custom input as well

Options

  • doc: implies that AI has been used to generate docs but not code
  • code: implies that AI has been used to generate code and docs

Examples

/**
 * This function has been created by a human, while the comment is AI generated
 * 
 * @ai doc - MistralAI Devstral2
 */
function MyClass() {}

/**
 * This function and comment are AI generated
 * 
 * @ai code - MistralAI Devstral2
 */
function MyOtherClass() {}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions