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

关注

原创最新推荐文章于 2026-04-28 09:13:15 发布 1.1k 阅读 AI 写同款· GEO 优化 ›

QT问题系列（9） - 如何给QSettings配置文件Ini注释源码参考：https://www.cnblogs.com/xian-yongchao/p/9549959.html 由于ini的项比较多的时候，我们就想为有些项添加注释，方便理解，下面就说下如何为ini文件注释： QSettings iniFile("./test.ini", QSettings::IniFormat); iniFile.setIniCodec(QTextCodec::codecForName("utf-8")); //在此添加设置，即可读写ini文件中的中文 //写阅读详情

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

一、私有文件注释

/////////////////////////////////////////////////////////////////////////////
//
//                  ※ 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)
//日    期:
//输入参数:
//输出参数:
//备    注:
////////////////////////////////////////////////////////////////////////////
//////
///////////////