文章目录
一、OpenCV的官方文档的写法
- 用
/** */
写注释块,不是用行注释//
也不是/* */
- 在第二行处加个空行。这样之后每行就不是以
*
开头(不方便复制)。 - 注释符号:
@brief
:简要描述@param
:参数描述@return
:用它来制定一个 method 或 function的返回值@note
:注意点@see
:用它来指明其他相关的 method 或 function . 你可以使用多个这种标签.
/** @brief Re-initializes Kalman filter. The previous content is destroyed.
@param dynamParams Dimensionality of the state.
@param measureParams Dimensionality of the measurement.
@param controlParams Dimensionality of the control vector.
@param type Type of the created matrices that should be CV_32F or CV_64F.
*/
void init( int dynamParams, int measureParams, int controlParams = 0, int type = CV_32F );