![]() */ /** \ fn void setName ( const std :: string & ) * \ brief Set the name to the workbench object. */ /** \ fn std :: string name () const * \ brief Returns the name of the workbench object. An alternative is using C++-style comments // with an additional slash, so ///. The special documentation block starts like a C-style comment /* but has an additional asterisk, so /** the block ends with a matching */. This keeps the declaration and documentation close to each other, so it's easy to update the latter one if the first one changes. Usually you'd want to document the code in the header file, just before the class declaration or function prototype. Of course, file members (functions, variables, typedefs, defines) do not need an explicit structural command just putting a documentation block before or after them will work fine.įirst style: documentation block before the code
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |