函数注释参考样例

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/lile777/article/details/50397178

//*---------------------------------------------------------------------------- 
//* Function Name       :  GetDiskAvailableSize
//* Object              :  获取 指定磁盘的 剩余 千字节数( KB)
//* Input Parameters    :  DiskMountPoint --- 磁盘挂载点名称, 关键字符即可
//                           转义字符需要添加反斜杠 ‘\’, eg: \0 即 空格
//                           挂载点名称 df  -h 指令可查看
//                         AvailableSize ----- 存储 获取到的剩余 千字节数
//* Output Parameters   :   0: 获取成功
//                         -1: 获取失败
//* GlobalVar.Referenced:  None
//* GlobalVar.Modified  :  None
//* CeateDate           :  2015.4.10
//* Author              :   
//* Modification Log    :  [Time] -- 2015.4.28
//*                        [Note] -- 获取使用率 改为 获取剩余 千字节数
//* Sample              :  GetDiskUsedProportion("mnt", &AvailableSize);
//*----------------------------------------------------------------------------

程序调试日志打印

#ifdef _DEBUG
#define qprintf(fmt...)   \
    do {\
        printf("\n[%s]-%s():%d: ", __FILE__,__FUNCTION__, __LINE__);\
        printf(fmt);\
        printf("\n");\
       }while(0)
#else
#define qprintf(fmt...)  fflush(stdout)
#endif

打印程序编译时间

printf("\nThis Application is compiled at %s,%s.\n",__TIME__, __DATE__);