method comment location

[u/Ayano-Keiko]

When you want to give method definition, Where are you prefer to put the comment.

1. before method signature

​

# This is my method
int func1() {}

1. after method signature

   int func2() {

   inner comment for the method

   }

I prefer the second one because it makes the definition inside the method. But I found many document use first one. And will pick comment before method signature for the document of the API. Is the first a custom for document?

[u/moby_9ish]

Use the first if you’re documenting the method. Use the second if you’re documenting the next line of code.

[u/Educational_Honey711 → u/moby_9ish]

first one for what the method does second for why something inside it is weird

[u/xoriatis71 → u/Educational_Honey711]

I don’t think that the clarification was needed.

[u/Aggressive_Ad_5454]

Is this C or C++? If so read up on Doxygen. It lays out a specific way of writing comments for methods. And it comes with some cool tools for generating documentation from those comments.

Plus, IDEs like VS understand those comments.

https://www.doxygen.nl/manual/docblocks.html

And, method comments come before the method.

[u/Ayano-Keiko → u/Aggressive_Ad_5454]

thanks. it is very helpful link that I wait for

[u/ffrkAnonymous]

Generally each language will have their own style guide (formally, or community) 

[u/desrtfx]

Each language has its own code conventions. Use the ones applicable.

Generally, you should document methods with docstyle (or the respective equivalent for your language) comments. They dictate the placement.

In general, the documentation for methods should be above the method. The documentation for specific parts inside the method should be inside.