Skip to content

Useful tags to add #17

@alburdette619

Description

@alburdette619

This is a list of annotations that I could think of to improve this library. This is only an extent of my knowledge of JS/Java/C#.

  • @generator: to document es6 generator,
  • @yields: to document what a generator yields (support multiple)
  • @interface: to document interfaces in OO based languages
  • @enum: to document enums
  • @export: to document module exports
  • @abstract: to document abstract classes
  • @static: to document static classes and members
  • @class: to document classes
  • @extends: to document class inheritance
  • @implements: to document interface implementation
  • @nullable: to document that a return type is nullable

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions