Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

An option to only include a brief description for functions #8

Open
fgimian opened this issue Sep 26, 2016 · 0 comments
Open

An option to only include a brief description for functions #8

fgimian opened this issue Sep 26, 2016 · 0 comments

Comments

@fgimian
Copy link

fgimian commented Sep 26, 2016

Hello there, thanks so so much for producing this extension, it's fantastic!

I was wondering if you would consider an option to have something like this: http://www.edparrish.net/common/cppdoc.html#functioncomment

i.e.

/**
    Encodes a single digit of a POSTNET "A" bar code.

    @param digit the single digit to encode.
    @return a bar code of the digit using "|" as the long
    bar and "," as the half bar.
*/
string encode(int digit);

Personally, I also think it's nice to have a colon after each parameter name similar to Python:

i.e.

/**
    Encodes a single digit of a POSTNET "A" bar code.

    @param digit: the single digit to encode.
    @return: a bar code of the digit using "|" as the long
    bar and "," as the half bar.
*/
string encode(int digit);

Thanks so much!
Fotis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant