编程函数注释规范

最新推荐文章于 2024-08-22 10:07:08 发布
最新推荐文章于 2024-08-22 10:07:08 发布
阅读量3.9k 收藏 1
点赞数
分类专栏： 012编程规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zeephom/article/details/80707719
版权
'-------------------------------------------------------------------------------------
'功能说明
'-------------------------------------------------------------------------------------
'简述:
'引用方法:
'解释:
'=====================================================================================
'参数说明
'-------------------------------------------------------------------------------------
'传入参数:
'参数1 ***

'函数参数:
'参数2 ***
'=====================================================================================
'依赖关系
'-------------------------------------------------------------------------------------
'** ***
低调的嚣张的程序员
关注
专栏目录
C/C++ 程序员编程规范之注释（参考）
探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。
02-05 4555
编程规范(注释) 注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释. 注释适当列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 源文件头部也应进行注释. 列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修...
Python通用编程规范-02注释
zhao12501的博客
04-06 1621
文章目录2.1 类、接口和函数2.1.1 类和接口的注释写在类声明(class ClassName:)所在行的下一行，并向后缩进4个空格2.1.2 公共函数的注释写在函数声明(`def FunctionName(self):`)所在行的下一行，并向后缩进4个空格2.2 属性2.2.1 公共属性的注释写在属性声明的上方，与声明保持同样的缩进。行内注释应以`#`和一个空格作为开始，与后面的文字注释以一个空格隔开2.3 格式2.3.1 模块注释写在文件的顶部，导入(`import`)部分之前的位置，不需要缩进2.
程序注释规则
04-08
初学者比较适用，一个好在注释习惯对程序员来说至关重要。
应用程序注释规范
weixin_30898109的博客
08-25 122
源文件注释规范 /*********************************************************** 文件名:** Copyright (c) 2005 - 2006 ******* 软件项目开发部门** 文件编号:** 创 建 人:** 日 期:** 修 改 人:** 日 期:** 描 述:*************************...
VBA注释 （＜*＞ + ＜*＞）
最新发布
时光会把你雕刻成，你应有的模样！
08-22 991
在VBA（Visual Basic for Applications）中，注释是一种用于向代码中添加说明或解释文本的方法，这些文本不会被执行。注释对于理解代码的目的、逻辑或特定部分的代码功能非常有帮助，尤其是在处理复杂或长的代码时。单行注释以单引号（'）开始，直到该行的末尾。单行注释只能注释掉它们所在行的内容。
编程标准之注释
编程资料大全
02-13 134
首先说说关于vs2010自动添加注释块，一是通过使用宏命令来添加注释，二是可以设置模版自动的生成注释，这样可以在新建一个类一个接口或是窗体时自动的生成该类、接口、或窗体的注释。当然给函数和过程写注释的时候可以用“,,,”来自动的生成注释块。 在给一行代码添加注释，不必选中该行，只要将光标定位到该行就可以通过菜单栏的图表添加，也可以通过使用两级快捷键来添加注释（Ctril+K,Ctrl+C）。 ...
编程语言注释方法大全
weixin_34274029的博客
06-13 1113
    编程语言注释方法大全 CreateTime--2017年6月13日18:54:25 Author:Marydon 每种语言都有自己的注释方式1.java的注释方法有3种： 　　a.//这是单行（行内）注释 　　b./* 这是多行注释 */ 　　c./** 　　　 * 类注释&方法注释 　　　 */2.CSS注释 　　/**/3.JAVASCRIPT注释 　...
Python编程-注释
swordheart的博客
01-25 369
注释：提高代码的可读性，注释必不可少，可以进行对部分代码进行调试 单行注释 # 快捷键 ctrl +/ 也可以选中多行，使用crtl+/ 多行注释 ''' 单引号 ''' | """ 双引号 """ 单引号和双引号都可以进行多行注释 注释的内容不会被程序执行 下图是有注释和没注释的效果 Python 中有两句特殊的注释，在py文件首行 #！/usr/bin/python3; #-- coding=uft-8 -- 这两句注释分别指的是指定python解析器的路径，指定编码格式，只能写在p
keil插件包(格式化代码 文件注释 函数注释 当前日期 当前时间)
02-07
Keil是一款广泛使用的嵌入式开发工具，尤其在微控制...但要注意，对于函数注释和插入日期时间等功能，可能需要结合其他工具或Keil内置的特性来完成。合理利用这些工具，能够显著提高开发效率，保持代码的质量和一致性。
程序编程规范(代码与注释).doc
11-21
"程序编程规范(代码与注释)" 程序编程规范是编程过程中至关重要的一部分，良好的编程规范可以提高代码的质量、...遵循这些编程规范和注释规范，可以提高代码的质量、可读性和可维护性，提高程序员的编程效率和质量。
注释代码的13技巧
郗晓勇|利己者生,利人者恒
03-27 3474
本文发表在作者José M. Aguilar的博客Variable Not Found，后来由Timm Martin翻译成英文发表在DevTopics上。以下是如何注释代码的13tips，它们会在日后帮助你更容易理解和维护代码。1. Comment each level（每个级别的注释有统一的风格）注释每一个代码块，并且在各个级别的代码块上，要使用统一的注释方法。例如： 对于类
代码整洁（2）：函数、注释
weixin_34377919的博客
06-23 122
《代码整洁之道》Clean Code A Handbook of Agile Software Craftsmanship 读书笔记 函数 短小 函数的第一规则是要短小。第二条规则是还要更短小。 if语句、else语句、while语句等，其中代码块应该只有一行。该行大抵应该是一个函数调用语句。这样不但能保持函数短小，而且，因为块内调用的函数拥有较具说明性的名称，从而增加了文档上的价...
程序编写规范之注释
康明的博客
03-30 3981
语言编写规范之注释 1. 注释原则 1.1 项目开发中，尽量保持代码注释规范和统一。 1.2 注释方便了代码的阅读和维护。 1.3 边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。 1.4 注释要简洁明确，不要出现形容词。 1.5 通过注释可以快速知道所写函数的功能，返回值，参数的使用。 2. 注释建议 2.1 一般情况下，源程序有效注释量必须在20％以上。 注释不宜太多、不宜太...
程序员必知的注释规范
李达
11-18 2233
前段时间就想着写写关于代码注释的博客，却迟迟没有写，一方面是因为这些实践性的内容，单靠总结意义不大；另一方面，总觉得注释是最基础的知识，一直在这里磨蹭也不是回事。但是反过来想想，最基础的反而是最欠缺的，以前做的东西，有很多存在注释不规范问题。         注释不规范的原因也很多：工程留给的时间不多；觉得繁琐，写了没什么用……这些都是浅层次的原因，深度挖掘，根本原因在自身的素质：浮躁、急功近利
五、函数的注解
布白的博客
02-23 852
函数注解、函数作为对象使用接口注解、函数可选参数，默认参数，剩余参数、this和箭头函数、函数重载
编程命名规范以及函数文件注释
weixin_44378835的博客
03-18 616
文章目录1 驼峰命名法1.1 小驼峰法1.2 大驼峰法（又叫帕斯卡命名法）2. 匈牙利命名法2.1 匈牙利命名法 - 属性2.2 匈牙利命名法 - 类型2.3 匈牙利命名法 - 描述3 下划线命名法4. 命名实例5. 函数注释6 文件注释 1 驼峰命名法 1.1 小驼峰法 除第一个单词之外，其他单词首字母大写（常用于变量） int myStudentNumber 1.2 大驼峰法（又叫帕斯卡命名法） 与小驼峰式命名法的最大区别在于，每个单词的第一个字母都要大写。（常用于类名，函数名，属性，命名空间） cl
【代码注释】代码中函数功能的详细注释和一些自由协议
David Xiao
01-25 903
Annotation /* * Purpose: use SRIF Factorization Matrix Update Time * ------------------------------------------------------------ * Example: * | Rwk_1 0 0 | QR -> | Rwk Rwx...
对编程注释的理解
lingduchunge的博客
02-27 1366
注释写得很出色很不容易，但是写得糟糕却是人人可为止，糟糕的注释反而会帮倒忙，给阅读代码的程序员指向了一个错误的方向。很多技术文档中，已经有很全面的说明，这里不再多说，下面仅说明下自己的一些见解。 怎样才能写出出色的注释 1、同一个工程中，注释的格式要统一，因为代码阅读器对不同位置的注释语句，显示格式是不同的，如果格式不统一，代码的外观就会给人的感觉很杂乱，导致可读性变差。 2、代码中的一...
编程规范：命名规则与函数注释标准
在函数注释方面，规范强调注释应包含三个部分：函数的功能简介、参数说明和返回值说明。这有助于其他开发者快速理解函数的作用。同样，变量注释也应当清晰地说明变量的内容及其代表的意义，以便于代码的理解和维护。...
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值