C++ style guide: Difference between revisions

Jump to navigation Jump to search
698 bytes added ,  21 September 2017
Moved the doxygen style guide from Doxygen.
(Moved the doxygen style guide from Doxygen.)
Line 210: Line 210:
   // alternative code in its absence
   // alternative code in its absence
  #endif
  #endif
== Doxygen ==
Doxygen documentation can be a great help when developing octave however the current state has a lot of room for improvement. For more information about Doxygen in Octave look at [[Doxygen]].
=== Doxygen Style Guide ===
Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project the following rules should be applied:
* For Doxygen comments use only {{codeline|//!}} and NOT {{codeline|/*! ... */}}
* Use {{codeline|@}} for any Doxygen Special Commands
An example  of properly used Doxygen would look like:
<pre>
//! Comment with special command and syntax highlighting:
//! @code{.cc}
//! double v = 1.0;
//! @endcode
</pre>


== Comments ==
== Comments ==
156

edits

Navigation menu