Skip to content

Double slash documentation #8

Description

@tgaldi

Double slash documentation

Color.Comment option to enable documentation color in double slash comments

I use code snippets to add documentation comments in the style // NOTE (MY.NAME):
With Color.Comment I have changed the snippet to /// @note (MY.NAME):

The @ is actually nice for searching ( find @todo ), but it would be preferable to maintain alignment of multi-line comments that begin with documentation.

/// @todo (MY.NAME): This is the first line
// which continues with a double slashes.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions