Skip to content

Consistent usage of keyword 'Remarks:' #3

@hoppfrosch

Description

@hoppfrosch

It's possible to use Remarks:-Keyword within Method-documentation section. This way additional information can be added to Method-documentation. This is especially useful if you want to add structure to your remarks using Markup:

/*!
    Method: test(x)
        bla
    Parameters:
        x - *(Optional)* bla
    Remarks:
        ### See also: 
            [test2](#test2)

        ### Author(s)
            * 20130308 - [hoppfrosch](hoppfrosch@anywhere.com) - bla
*/

I failed to find a way to add something similar to the class- or library-documentation block ..

Wouldn't it make sense to support Remarks:-Keyword within method as well as property, class and library documentation (what else?) sections to get some consistency and make usage of Remarks: more intuitive?

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