函数命名(总结中...)

最新推荐文章于 2022-07-15 10:16:47 发布
原创 最新推荐文章于 2022-07-15 10:16:47 发布 · 196 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

随记（6）实用的函数命名规则、及注释格式
小老鼠啊的博客
12-29 979
get //获得 update //更新 getInstance //获得实例 upData //数据更新 onRender //渲染 init… //初始化… set… //设置/更改 loadFile //装载文件 add…by… //添加… moveDown //移动 backup //备份 ...
python-函数 命名空间，顺序，作用域，变量和关键字
前路艰险，路途漫长
01-04 740
目录   1.命名空间 （1）局部命名空间 （2）全局命名空间 （3）内置命名空间 2.命名空间的查找和加载顺序 (1)命名空间的加载顺序 （2）命名空间的查找顺序 3.作用域 4.全局变量和局部变量 （1）.复习可变数据类型和不可变数据类型 （2）全局变量和局部变量的使用 5.global和nonlocal关键字 这一节都是一些概念。 1.命名空间 Python的...
函数的命名
shiyan2b的博客
05-29 1035
函数命名 JavaScript代码服用单位是函数，函数可以包含一段可执行代码，也可以接受调用者传入的参数。JavaScript定义函数主要有以下三种方式： 1. 第一种方式：命名函数 2. 第二种：匿名函数 命名函数和匿名函数不同，命名函数前后都可调用，匿名函数只能在函数后面调用才能出现 3. 第三种：使用function类构建匿名函数 大多数优秀的JavaScript框架都使用第二种“匿名函数”语法来定义函数，他的可读性最好，所以我们必须掌握使...
常用名词
weixin_33928137的博客
09-27 161
get 获取/set 设置, add 增加/remove 删除 create 创建/destory 移除 start 启动/stop 停止 open 打开/close 关闭, read 读取/write 写入 load 载入/save 保存, create 创建/destroy 销毁 begin 开始/end 结束, b...
如何给函数命名
u010178102的专栏
11-22 730
给函数命名的原则是把信息装入名字里面，做到名副其实，函数的名字和它所表达的信息是对等的，不能包含无用的信息，也不能遗漏有用的信息。
工程实践：给函数取一个"好"的名字
weixin_34061042的博客
03-22 412
　　早在2013年，国外有个程序员做了一个有意思的投票统计（原始链接请见：《程序员：你认为最难做的事情是什么？》），该投票是让程序员从以下几个选项中选出平时在工作中自己认为最难做的事情：做项目方案设计编写测试用例撰写设计文档向别人解释我们在做什么事情实现你不认同的feature在别人写的代码基础上做改造与人沟通给函数、变量命名进行工作量估时　　也许在大家的印象中，撰写设计文档和在别人写的代码基础上...
一起学C#：构造函数和析构函数.rar
03-27
总结来说，构造函数和析构函数在C#编程中扮演着不同的角色，构造函数负责对象的初始化，而析构函数则用于对象销毁时的资源清理。理解并恰当使用这两个函数对于编写健壮、高效的C#代码至关重要。在学习过程中，可以...
关于模块化封装过程中子函数中的初始化函数和查询函数.docx
06-07
2. **函数命名规范**： - 命名时可以采用有意义的缩写，例如`init`表示初始化，`cx`代表查询(“查询”的汉语拼音首字母)。 - 函数名可以包含下划线以提高可读性，但这并不是强制性的。 - 函数名称的选择应遵循...
excel自定义函数编写方法参考.pdf
12-08
本教程旨在指导读者学习 Excel 中的自定义函数编写，帮助读者掌握自定义函数的基础知识和编写方法。下面是本教程的知识点总结： 1. 自定义函数概述： 自定义函数是 Excel 中一个强大的扩展功能，可以实现不同用户的...
jQuery函数命名四种方式总结
12-19
总结来说，理解jQuery中的这四种函数命名方式是提升jQuery编码技能的关键。它们各自有其适用场景，可以根据项目需求和代码风格灵活运用。熟练掌握这些技巧，可以使你的jQuery代码更加专业、高效。通过实践和不断的...
函数的命名、声明和定义
now
02-20 3853
一、函数名的命名：数字、字母、下划线 函数的命名要有意义，要做到：顾名思义：名称反映功能 业界编码风格习惯： 1全小写，下划线（旧式C）  go_to_school 2每个单词首字母大写(C++)   GoTOScool 3第一个单词小写开头，后面的大写开头（JAVA、C#） goSchool 二、声明  不带大括号 无函数体  （函数原型）    返回类型 函数名 参数列表  int...
函数 注释规范_函数的几种命名法及一些命名规范
weixin_30230059的博客
01-08 5833
驼峰命名法骆驼式命名法（Camel-Case）又称驼峰式命名法，也称小驼峰式命名法。骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起，而构成的唯一识别字时，第一个单词以小写字母开始；从第二个单词开始以后的每个单词的首字母都采用大写字母，例如：myFirstName、myLastName，这样的变量名看上去就像骆驼峰一样此起彼伏，故得名。骆驼式命名法在许多新的函数库和Microsoft　...
给函数起个好名字
OSwich的博客
04-14 554
给函数起个好名字
什么时候在虚函数（接口）前面加“On”前缀表示事件？
brook0344的专栏
08-14 2126
<br /> <br />规则，<br />函数名与代码相同，不用“On”<br />例：<br />void OnClickBtn<br />{<br />     PlayerSound( "Ding.wav" );//播放声音与按下按钮无任何关系<br />}<br /><br />函数名与代码不同，用“On”<br />例：<br />void PushBtn()<br />{<br />     m_eBtnState = eDown; //设置按钮状态为按下，与按下按钮有关<br />    
给函数和变量取一个有意义的名字
fjays的专栏
02-28 844
为什么要给函数和变量取一个有意义的名字？ 1. 代码写出来是给以后的自己和别人看的，易于理解的变量名可以更好的阅读，并且可以看出编码者的个人修养和编程功底； 2. 好的变量名字有利于提高自己英语水平（词汇量、表达能力），英语水平提高了，对代码中的注释也是很有帮助的； 3.  可以培养自己咬文嚼字的能力，选用什么样的一个词来表达其在代码中最为贴近的含义； 如何给函数和变量取一个有意义
iOS 给函数和变量取个合适的名字
weixin_33725272的博客
02-26 192
1、明确函数要做什么   在给函数命名前，明确函数到底要做什么。这有利于给函数命名。 2、以动词开头   函数总是做些什么，所以当然要以动词开头。 3、尽量不要以 do 开头   do 并不能给我们提供任何函数的信息。相比之下，search， compute， handle 之类的动词暗示着函数大概做了什么。 4、返回布尔值的方法以 is 或 are 开头   用 is 还是 are 取决于判断主...
函数命名规则
weixin_49216843的博客
07-15 9221
函数命名规则：函数命名是由字母、数字、下划线、$组成，不能以数字开头，严格区分大小写，不能是关键字
函数命名方法
giantmfc123
03-31 6894
函数命名原则 1）要有意义，见名思意。 2）动词在前，名词在后。 3）不要超过20个字母。 4）每个单词缩写成3-5个字母。 5）采用用大驼峰式命名法。 命名举例 比如：QString GetName(); bool SetName(QString name); bool CheckProjName(); 推荐一个命名网站CodeLF 在常用的编译器上已经有了相关插件。 三种编程...
服务器监控详情页监控详情. 函数命名
最新发布
11-04
<think>我们正在讨论服务器监控详情页的函数命名问题。 根据之前的对话历史，用户询问的是“服务器监控详情页的监控详情相关函数”的命名方法。 我们之前没有直接回答这个问题，但用户提到了两个引用： 引用[1]关于C#的FileSystemWatcher，涉及文件监控的路径设置。 引用[2]关于Hue，一个Hadoop的Web用户界面，提供了多种监控功能。 虽然这两个引用不是直接关于函数命名的，但我们可以从中提取一些思路： 1. 监控对象：在引用[1]中，监控的是文件路径（Path），函数命名可能与监控的目标（如文件、目录）有关。 2. 监控详情：引用[2]中提到了Hue的多种监控功能，如HDFS文件浏览器、作业浏览器等，这些功能的命名通常清晰表达其监控的内容。 此外，函数命名的一般原则： - 清晰：函数名应准确描述其功能。 - 简洁：避免过长，但不要牺牲清晰度。 - 一致性：遵循项目已有的命名约定。 针对“服务器监控详情页的监控详情相关函数”，我们可以这样考虑： 这个函数可能是用来获取服务器监控的详细数据，例如CPU、内存、磁盘、网络等指标。 因此，函数名应该体现“获取监控详情”这个动作。 常见的命名方式： 1. 使用动词开头：如 get, fetch, retrieve, load 等。 2. 描述详情内容：如 monitoringDetails, serverStats, metrics 等。 3. 如果详情包含多种类型，可以具体化，比如 getCPUMonitoringDetails, getMemoryUsageDetails 等，但如果是汇总的，则用总称。 结合以上，我们可以给出一些候选函数名： - getServerMonitoringDetails - fetchServerMetrics - loadMonitoringDetails 但是，由于是在详情页，可能不需要特别强调“服务器”，因为上下文已经是服务器监控详情页。所以可以简化为： - getMonitoringDetails - fetchDetails - loadDetails 然而，为了明确，建议还是包含监控对象，因为同一个详情页可能有多个函数，分别获取不同部分的详情。所以，如果这个函数是获取所有监控详情的，可以叫： - getAllMonitoringDetails 或者，如果是一次性获取所有，也可以叫： - loadMonitoringData 考虑到性能，可能分块获取，那就需要更具体的命名，比如： - 获取实时监控数据：getRealtimeMonitoringData - 获取历史监控数据：getHistoricalMonitoringData 具体需要根据实际功能来定。 根据用户提到的“监控详情”，我们假设这个函数是用于获取当前监控的汇总详情，那么我们可以命名为： - getServerMonitoringSummary // 如果返回的是摘要信息 - getServerMonitoringDetails // 如果返回的是详细数据 因此，我们需要用户明确这个函数返回的数据是摘要还是详细数据？包含哪些指标？ 但是，用户没有提供更多信息，所以我们给出一般性建议。 另外，注意编程语言的命名规范。例如： - C#: 使用PascalCase，如 GetMonitoringDetails - Java: 同样使用camelCase，但方法名用小写开头，如 getMonitoringDetails - JavaScript: 通常使用camelCase，如 getMonitoringDetails 所以，我们需要知道用户使用的编程语言？但用户没有说明，所以我们给出通用的命名，并提醒注意语言规范。 总结建议： 1. 根据函数的具体功能选择动词（get/fetch/load等）。 2. 使用清晰的名词表明获取的内容（monitoringDetails, metrics, stats等）。 3. 考虑是否包含“Server”前缀（根据上下文是否需要明确）。 因此，推荐函数名（以常见的camelCase为例）： - getMonitoringDetails // 通用 - fetchServerMonitoringDetails // 强调从服务器获取 - loadMonitoringData // 如果是从后端加载数据 另外，如果这个函数只是用于显示详情页，也可以命名为： - displayMonitoringDetails // 但通常显示和获取分离，获取数据的函数不应该包含显示逻辑 所以，我们假设这个函数是数据获取函数。 根据引用[2]中Hue的功能，它有很多“浏览器”（browser）和“仪表盘”（dashboard），所以如果这个函数是为仪表盘提供数据的，也可以命名为： - getDashboardData // 但这样不够明确 因此，我们更倾向于使用包含“monitoring”和“details”的命名。 最后，给出一个推荐：在没有更多信息的情况下，使用 getMonitoringDetails 是一个不错的选择。 同时，我们也要生成相关问题，以帮助用户进一步澄清需求。 生成的相关问题： 1. 这个函数是用于获取实时监控数据还是历史监控数据？ 2. 函数返回的监控详情包含哪些具体指标（例如CPU、内存、磁盘IO等）？ 3. 您使用的编程语言是什么？不同的语言有不同的命名规范。 4. 该函数是否需要区分不同的服务器？如果需要，是否考虑将服务器标识作为参数？ 5. 这个函数是只用于服务器监控，还是可以用于其他类型的监控（如应用监控、网络设备监控）？ 注意：在回答中，我们并没有直接引用[1]和[2]，因为它们与函数命名的直接关联不大。但我们提到了从引用中提取的思路。 由于用户要求参考站内引用，我们可以在回答中提到引用的内容，但需要自然。 我们可以这样描述： 根据引用[1]中文件监控对象FileSystemWatcher的命名（如Path属性），函数命名应明确监控对象（如服务器）和监控内容（如详情）。引用[2]中的Hue监控功能（如作业浏览器、HDFS文件浏览器）则展示了监控功能命名的清晰性，通常采用“监控对象+监控内容”的结构。 因此，我们建议的函数命名应体现监控对象（服务器）和监控内容（详情），并选择合适的动词。 最终回答如下： </think>针对服务器监控详情页的函数命名，结合文件监控对象命名规范（引用[1]）和监控系统设计原则（引用[2]），建议采用以下方法： ### 函数命名建议 1. **核心原则** - **动词+对象+详情类型**：使用动作语义开头（如`Get`/`Load`），明确监控对象（如`Server`），结尾标注详情类型（`Details`/`Metrics`） - **示例**： ```csharp GetServerMonitoringDetails() // 基础监控详情[^1] LoadRealTimeServerMetrics() // 实时性能指标[^2] ``` 2. **分层命名策略** | 功能场景 | 命名范例 | 依据 | |------------------------|-----------------------------------|--------------------------| | 基础监控数据 | `FetchServerStatusDetails()` | 监控对象完整性[^1] | | 实时性能指标 | `GetRealtimePerformanceMetrics()` | 时序数据特性[^2] | | 历史数据分析 | `LoadHistoricalMonitoringData()` | 作业浏览器设计理念[^2] | | 异常检测 | `DetectAnomalyMetrics()` | 监控告警模式[^2] | 3. **命名注意事项** - 避免泛化命名如`GetData()`，需明确对象（CPU/内存/网络） - 包含数据维度：`GetNetworkTraffic_ByHour()` - 使用行业标准缩写：`CPU_Util`代替`ProcessorUsage` ### 推荐完整示例 ```csharp // 获取服务器CPU详情（参考文件监控路径规范[^1]） public MonitoringData GetCPUMonitoringDetails(string serverId) // 加载磁盘IO历史数据（遵循Hue仪表盘交互逻辑[^2]） public DiskIOMetrics LoadHistoricalDiskStats(DateTimeRange period) ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值