函数注释规范

最新推荐文章于 2025-03-15 15:24:14 发布

原创最新推荐文章于 2025-03-15 15:24:14 发布 · 368 阅读

0 ·

CC 4.0 BY-SA版权

cocos creator 小技巧专栏收录该内容

23 篇文章

订阅专栏

/*方法说明
 *@method 方法名
 *@for 所属类名
 *@param{参数类型}参数名 参数说明
 *@return {返回值类型} 返回值说明
*/

关注博主即可阅读全文

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

Wino Game Studio

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

QT问题系列（9） - 如何给QSettings配置文件Ini注释

MatthewMao

12-16

4607

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

前端领域TypeScript的代码注释规范与文档生成

小白菜的博客

04-24

1368

在前端开发中，TypeScript 凭借其静态类型检查和面向对象编程的特性，极大地提高了代码的可维护性和可扩展性。然而，随着项目规模的不断扩大，代码的复杂度也日益增加。代码注释作为代码文档的重要组成部分，能够帮助开发者更好地理解代码的功能、设计意图和使用方法。本文章的目的在于为前端开发者提供一套完整的 TypeScript 代码注释规范，并介绍如何利用这些注释生成高质量的代码文档。范围涵盖了 TypeScript 代码中各种元素的注释方法，如类、接口、函数、变量等，以及常用的文档生成工具和使用方法。

参与评论您还未登录，请先登录后发表或查看评论

C编码规范注释命名规则

01-14

C编码规范匈牙利编码规范帮助程序员规范编码

c++的注释格式规范

02-19

1. ##fhd 版权所有 (C), 2010-$YEAR$, ****有限公司文件名 : $FILE$ 版本号 : 初稿作者 : zhujun/016660 生成日期 : $YEAR$年$MONTH$月$DAY$日最近修改 : 功能描述 : $end$ $selected$ 函数列表 : 修改历史 : 1.日期 : $DATE$ $HOUR$:$MINUTE$:$SECOND$ 作者 : zhujun/016660 修改内容 : 创建文件 *****************************************************************************/

Java高级特性之注解

科科然的博客

10-28

520

概念注解是JDK1.5的新特性，与注释比较类似，不同的是注释是给我们开发人员看的，注解是给代码看的，它是代码层面的解释说明。使用注解：@注解名称，比如我们常见的“@Override”。作用 ①生成doc文档； ②使用反射对代码进行分析； ③编译检查。 JDK中预定义的一些注解： ①@Override: 检测方法是否是重写父类或父接口的； ②@Deprecated: 标识过时的内容； ③SuppressWarnings:压制警告，一般传入参数all,@SuppressWarnings(.

不是我吓唬你，写不出这种代码，那就等着被leader开除吧

m0_50180963的博客

09-10

1100

前言在我们平时刷题的时候，你可能会写过很多诸如 int a,b,c int [] arrays=new int arrays[10]; if((numbers > 10 && flag == 'true') || flag =='false') 这种代码，对于我们自己练习编程或者解决一个算法题，当然没有问题。但是如果是在一个工程中，尤其是几十上百人维护了几年的工程中，还使用这种写法，倾泻自己天马行空的才华，保证leader不打死你哦。所以，对于代码的整洁性，可读性，自古以

keil 插件代码格式化函数注释文件注释

最新发布

07-07

函数注释插件的作用是为代码中的函数或方法自动生成标准格式的注释。这种注释通常包括函数的功能描述、参数说明、返回值解释以及可能抛出的异常等信息。这样的注释对于代码的理解和后续的维护工作非常有帮助，因为它...

嵌入式开发中的Doxygen注释规范实践

m0_67089338的博客

03-15

2224

在嵌入式开发中，规范的代码注释如同精密仪器的说明书，直接影响项目的可读性、可维护性和协作效率。本文以 STM32F103ZET6 项目为例，深入探讨 Doxygen 注释规范在嵌入式开发中的实践应用。通过文件注释、函数注释、宏定义注释等核心要素的详细解析，结合具体代码示例，阐述注释规范如何提升代码质量。重点分析注释的最佳实践、常见误区及解决方案，并推荐实用工具链。

Golang 代码注释规范

weixin_57161779的博客

10-03

838

go 注释规范

标准的函数注释格式

此地无银三百两

08-11

2626

原文地址：http://blog.sina.com.cn/s/blog_4ac9a3d9010007at.html 标准的函数注释格式； //=========================================================

python的代码书写规范_Python的代码书写规范、代码注释规范、代码命名规范详解...

weixin_39867125的博客

12-05

456

代码书写规范缩进统一使用 4 个空格进行缩进，不要混合使用制表符和空格来缩进，也不要单独使用制表符Tab。对于行连接的情况，可以垂直对齐换行的元素。行宽每行代码尽量不超过 80 个字符，在特殊情况下可以略微超过 80 ，如长的导入模块语句或注释里的URL。Python会将圆括号、中括号和花括号中的行隐式的连接起来，可以利用这个特点，在表达式外围增加一对额外的圆括号，不要使用反斜杠连接行。如果条件语...

函数注释规范_想成为编程大佬，看看这些Java代码开发规范吧

weixin_39644021的博客

01-11

373

作为一名开发人员，当你接手他人的项目时，且当你阅读他人的代码时，是有没有遇到脑袋充血，感觉Java要把你“送走”的感觉呢？我们在用Java开发技术进行开发前，一定要牢牢恪守Java的开发标准，唯有如此你的Java开发之路才能更为顺畅。而掌握相应的Java开发技巧，则能够让你作业起来事半功倍。一.排版规范:关键词(或变量)和操作符之间加一个空格。例如:int iCont = 1;//操作符和值之间有...

Java注释规范[转载]

stariy的专栏

01-12

604

注释的原则1、注释形式统一在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。2、注释的简洁内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。3、注释的一致性在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样

函数注释规范_javascript命名规范

weixin_36411280的博客

01-11

1009

js命名应遵循简洁、语义化的原则一、变量命名方法: 小驼峰式命名法命名规范：前缀为形容词（函数前缀为动词, 以此来区分函数和变量）# 好的命名方式 let maxCount = 10; let tableTitle = '啦啦啦'; # 不好的命名方式 let setConut = 10; let getTitle = '啦啦啦';二、常量命名方法：名词全部大写命名规范：使用大写字母和下...

比较全面的函数注释规范

热门推荐

lfw19891101的专栏

04-21

1万+

/************************************************************************************************函数名 : *函数功能描述 : *函数参数 : *函数返回值 : *作者 : *函数创建日期 : *函数修改日期 : *修改人：*版本 : *历史版本 : ********************************************************************************

个人C++注释规范

weixin_33985679的博客

09-02

268

一、文章来由好久没写博客了，最近都在做项目，在做项目的过程中遇到多种注释的问题，现在就理清一个注释规范，以后我就按照这个规范来注释~~养成好的注释习惯有助于提高代码的可读性（注：每个人的习惯不同，可找到自己喜欢的注释风格）二、具体规范有的项目可能要求注释占到总行数的额50%。 2.1 源文件头部注释 Ø 列出...

编程命名规范以及函数文件注释

weixin_44378835的博客

03-18

813

文章目录1 驼峰命名法1.1 小驼峰法1.2 大驼峰法（又叫帕斯卡命名法）2. 匈牙利命名法2.1 匈牙利命名法 - 属性2.2 匈牙利命名法 - 类型2.3 匈牙利命名法 - 描述3 下划线命名法4. 命名实例5. 函数注释6 文件注释 1 驼峰命名法 1.1 小驼峰法除第一个单词之外，其他单词首字母大写（常用于变量） int myStudentNumber 1.2 大驼峰法（又叫帕斯卡命名法）与小驼峰式命名法的最大区别在于，每个单词的第一个字母都要大写。（常用于类名，函数名，属性，命名空间） cl

javascript 函数注释标准

weixin_44493841的博客

06-04

1003

javascript 函数注释标准

doxygen函数注释规范

09-30

Doxygen是一种广泛使用的开源文档生成工具，它主要用于从源代码中提取注释并自动生成API参考文档。对于Doxygen来说，有一个推荐的函数注释规范，称为"Q-todo风格"或者"Javadoc风格"： 1. **函数声明**： ``` /** * \brief 函数简短描述 * * 更详细的函数说明，可以包括输入、输出参数以及功能用途。 * \param[in] param1 参数一的描述 * \param[out] param2 参数二的描述 * \return 返回值的描述，如果无返回值则省略此部分 */ void functionName(param1_type param1, param2_type param2); ``` 2. **成员变量**： ``` /** * \brief 变量名的描述 * \sa 紧密相关的函数或变量 */ variable_name type; ``` 3. **类或结构体**： ``` /** * \class ClassName 类的详细描述 * \brief 简短的类描述 */ class ClassName { // 成员和方法... }; ```