c语言模块 文件 级注释,c语言模板代码注释架构-头文件

/**

******************************************************************************

* @file    XXX.h

* @author  lishelin

* @version V1.0.1

* @date    XX-XX-2018

* @brief

******************************************************************************

* @attention

*

*MIT License

*

*Permission is hereby granted, free of charge, to any person obtaining a copy

*of this software and associated documentation files (the "Software"), to deal

*in the Software without restriction, including without limitation the rights

*to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

*copies of the Software, and to permit persons to whom the Software is

*furnished to do so, subject to the following conditions:

*The above copyright notice and this permission notice shall be included in all

*copies or substantial portions of the Software.

*THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

*IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

*FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

*AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

*LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

*OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

*SOFTWARE.

*

* Change Logs:

* Date           Author       Notes

* 2018-XX-XX     lishelin     the first version

*

*

© COPYRIGHT 2018 lishelin0505@163.com

******************************************************************************

*/

/* Define to prevent recursive inclusion -------------------------------------*/

#ifndef XXX_H

#define XXX_H

#ifdef __cplusplus

extern "C" {

#endif

/* Includes ------------------------------------------------------------------*/

/**   @defgroup XXX

* @brief XXX driver modules

* @{

*/

#define XXX_MODULE    //if we don't need this function ,please comment it

#ifdef XXX_MODULE

/** @defgroup XXX_Exported_Constants

* @{

*/

/**

* @}

*/

/** @defgroup XXX_Exported_Types

* @{

*/

/**

* @}

*/

/** @defgroup XXX_Exported_Functions

* @{

*/

/**

* @}

*/

#endif //end of XXX_MODULE

/**

* @}

*/

#ifdef __cplusplus

}

#endif

#endif

/******************* (C) COPYRIGHT 2018 lishelin0505@163.com *****END OF FILE****/

阅读(2151) | 评论(0) | 转发(0) |