注释
- a. 由于变量可能到处被定义和引用,当它被引用的次数很多时,就很难找到这个变量的含义。可以变量值前面需要加上@,这样搜索变量的含义很快。
- b. 注释是不参与编译的
- c. 文件开头注释可以清楚表明文件作用,功能
范例一
/*===========================================================================
* FUNCTION : set_parameters
*
* DESCRIPTION: set camera parameters
*
* PARAMETERS :
* @device : ptr to camera device struct
* @parms : string of packed parameters
*
* RETURN : int32_t type of status
* NO_ERROR -- success
* none-zero failure code
*==========================================================================*/
范例二
/*******************************************************************************************
File Name: gc1064_dvp.c
Version: 1.00
Discription: GC1064
Author: xzpin
Email :
Date:2024.01.11
Copyright:(c)JIELI 2024 @ , All Rights Reserved.
*******************************************************************************************/