代码编写中关于文件/函数注释的统一格式

最新推荐文章于 2023-09-15 21:20:59 发布

PerfectToday

最新推荐文章于 2023-09-15 21:20:59 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

分类专栏： VC++6.0开发资料库文章标签： microsoft windows dll xp c

本文链接：https://blog.youkuaiyun.com/PerfectToday/article/details/4814682

VC++6.0开发资料库专栏收录该内容

34 篇文章

订阅专栏

本文介绍了一种规范化的代码注释方式，包括私有文件及函数的注释模板。作者通过详细示例展示了如何为文件和函数添加注释，以便于理解和维护。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

规范自己的代码习惯，特别是注释习惯，另外对于大函数内部的重要功能也要给予注释

一、私有文件注释

/////////////////////////////////////////////////////////////////////////////
//
//                  ※ ShuaiLI Share Memory Communication DLL ※
//
/////////////////////////////////////////////////////////////////////////////
//
//        ※作    者: 李帅※
//        ※创建日期: 2009年11月16日 ※
//        ※文件名称: SShareMem.cpp ※
//        ※版    本: 1.0 ※
//        ※发布日期: 2009年11月16日 ※
//        ※适用系统: Microsoft Windows 2000 / XP ※
//        ※开发环境: Visual C++ 6.0 / #include "windows.h" ※
//        ※描    述: Share Memory Communication ※
//        ※优快云:      PerfectToday ※
//        ※E-mail:    lishuaitool@hotmail.com ※
//
/////////////////////////////////////////////////////////////////////////////
//                  ※ Copyright (C) 2009, ShuaiLI-GOTOVC ※
/////////////////////////////////////////////////////////////////////////////

二、私有函数注释

////////////////////////////////////////////////////////////////////////////
//////
///////////////
//函数名:
//功    能:
//创建者:      GOTOVC(msn: lishuaitool@hotmail.com)
//日    期:
//输入参数:
//输出参数:
//备    注:
////////////////////////////////////////////////////////////////////////////
//////
///////////////