![]() |
MySQL 9.0.0
Source Code Documentation
|
/* This is how a multi-line comment in the middle of code should look. Note it is not Doxygen-style if it is not at the beginning of a code enclosure (function or class). */ /* *********This comment is bad. It's indented incorrectly, it has * additional asterisks. Don't write this way. * **********/ |
/* We must check if stack_size = Solaris 2.9 can return 0 here. */ |
// We must check if stack_size = Solaris 2.9 can return 0 here. |
{ qc*= 2; /* double the estimation */ } |
/* This is a standalone comment. The comment is aligned to fit 79 characters per line. There is a period at the end of each sentence. Including the last one. */ |
Use the following example as a template for function or method comments.
/**Initialize SHA1Context. Set initial values in preparation for computing a new SHA1 message digest. @param[in,out] context the context to reset @return Operation status @retval SHA_SUCCESS OK @retval != SHA_SUCCESS sha error Code */ int sha1_reset(SHA1_CONTEXT *context) { ... |