点群に直線を当てはめる
void cvFitLine( const CvArr* points, int dist_type, double param, double reps, double aeps, float* line );†
関数の概要.引数の型は適宜覚え易く変えてよい(例:const CvArr*→CvMat*)
- 引数名:型の○○(例 size:CvSize型の画像のサイズ)
- 箇条書きで記述
- 長い説明は解説の項に記述
返り値†
- △△型の○○の値
- void型なのでなし
- 1個でも箇条書きに
戻り値の型 変数名( 引数のリスト);†
関数複数から成り立つ場合は各関数ごとに引数と返り値の項を用意
返り値†
- 入力のデータ,内部計算などについて説明
- 箇条書きで記述
サンプルコード†
//サンプルコードはこのようにボックスにして記述.
//行頭に半角スペースを入れた行を連続させることによって可能.
IplImage* input = cvCreateImage( cvSize( 320, 240), IPL_DEPTH_8U, 1);
cvReleaseImage( &input);
//cvReleaseImageはIplImage**型が引数IplImage*型ではない
//なるべくコメントを多く残すこと
//この項は省略可
実体ファイル†
- OpenCVがインストールされた場所からの相対パスで記述
- (例: cxcore/include/cxcore.h)
- ヘッダファイルと実体ファイル(通常cpp)の2つを記述
- 陥りやすいミスなどを記述
- 解説の項に統合しても構わない
最後にOpenCVのタグを記述→ジャンル:OpenCV:OpenCV 1.0準拠