首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

方法评论和注释......每个应该去哪里?

方法评论和注释应该放在代码中的相应位置,以提供对代码功能和实现细节的解释和说明。具体来说,方法评论和注释应该放在以下位置:

  1. 方法头部:在方法定义的上方,用来描述方法的功能、输入参数、返回值和异常情况等信息。可以使用注释块(/ ... /)或者单行注释(//)来进行注释。

示例:

代码语言:java
复制
/**
 * 计算两个数的和
 * @param a 第一个数
 * @param b 第二个数
 * @return 两个数的和
 */
public int add(int a, int b) {
    return a + b;
}
  1. 方法内部:在方法内部的关键代码块前面或者代码行的末尾,用来解释代码的作用和实现细节。可以使用单行注释(//)或者行尾注释(/ ... /)来进行注释。

示例:

代码语言:java
复制
public void printName(String name) {
    // 打印姓名
    System.out.println("Name: " + name);
}
  1. 特殊情况:在代码中存在特殊情况或者需要额外说明的地方,可以在相应位置添加注释,以便其他开发人员理解和维护代码。

示例:

代码语言:java
复制
public void divide(int a, int b) {
    if (b == 0) {
        // 除数不能为零
        throw new IllegalArgumentException("除数不能为零");
    }
    // 执行除法操作
    int result = a / b;
    System.out.println("Result: " + result);
}

总之,方法评论和注释的目的是提高代码的可读性和可维护性,帮助他人理解代码的功能和实现细节。在编写注释时,应该清晰、简洁地描述代码的作用和意图,并遵循统一的注释规范。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

什么是PEP8?

开发人员的编码风格使代码更加可靠,每个开发人员都应该记住,Python 严格遵循字符串的顺序格式。 良好的编码风格使代码更具可读性。...圆括号、方括号大括号可用于换行。优先使用它们,而不是反斜杠。...因此,我们可以在每个步骤之间插入一个空行。 评论 注释是任何编程语言的重要元素。这些是描述代码的最有效方法。当我们用适当的注释记录我们的代码时,任何人都可以理解它。但请记住以下几点。...如果代码发生更改,请更新注释注释和文档字符串行长度限制为 72 个字符。 屏蔽评论注释是一小部分代码的绝佳解决方案。在编写多行代码以实现单个操作(如循环迭代)时,此类注释非常有用。...PEP 8 中指定了内联注释的以下限制。 以 a 单个空格开始您的评论。 谨慎使用内联注释 我们应该将内联注释与它们所引用的语句分开在同一行。

1.3K40

【译】Google 官方文章——如何去做coder review

当达成共识变得特别困难时,reviewer作者需要进行面对面会议,而不是仅仅试图通过代码审查注释来解决冲突。(不过,如果这样做,请确保将讨论结果记录在CL的评论中,以供将来的读者阅读。)...reviewer特别注意一下过度设计。鼓励开发者解决他们知道现在需要解决的问题,而不是推测将来可能需要解决的问题。...这些注释是否真的必要? 通常注释是解析这段代码为什么存在的时候是相当有用的,而不应该去解释某段代码正在做什么。如果代码本身不能解释清楚的话,意味着它更加需要简化了。...但对于大部分注释来说是用来说明那些不包含在程序本身但资讯,比如说为什么要这样子做的理由 查看该CL之前的注释也很有帮助,或许有一个todo项目现在可以一处、一个评论建议为什么不要进行这种更改等等。...其实透过简单的一句话让对方知道哪里做得很好,未来他们会将继续保持下去,并为其他开发者带来的正面影响 image.png 标明每个commit 修改什么,可以帮助reviewer快速进入状况 image.png

58350
  • 房天下数据爬取及简单数据分析

    明确了目的以后就该去寻找这些数据的出处,也就是网站,由于太原互联网环境欠发达,所以好多房产APP上都没有太原,有的APP有,但是也只有几十家楼盘,最后在搜索的过程中锁定了房天下。...b_adress.append(adress1.text.strip()[0:5].strip()) print (i,len(b_adress)) #开始抓取楼盘价格的循环,循环注释与前面类似...,循环注释与前面类似 value_num=soup. find_all(class_='value_num') for num1 in value_num:...因为必须保证楼盘、区域、价格、评论数一一对,所以我们采取向指定的确实位置插入值。...,挑选出评论数前十的楼盘 评论数量一定程度上可以说明该楼盘的受欢迎程度,上图表为太原市热评前十的楼盘。

    1.7K81

    Google: 如何做code review?

    当达成共识变得特别困难时,reviewer作者需要进行面对面会议,而不是仅仅试图通过cr的注释来解决冲突(不过,如果这样做,请确保将讨论结果记录在CL的评论中,以供将来的读者阅读)。...reviewer特别注意一下过度设计。鼓励开发者解决他们知道现在需要解决的问题,而不是推测将来可能需要解决的问题。...这些注释是否真的必要通常注释是解析这段代码为什么存在的时候是相当有用的,而不应该去解释某段代码正在做什么。如果代码本身不能解释清楚的话,意味着它更加需要简化了。...查看该CL之前的注释也很有帮助,或许有一个todo项目现在可以一处、一个评论建议为什么不要进行这种更改等等。 要注意的是,注释与class、module、function的文件不同。...其实透过简单的一句话让对方知道哪里做得很好,未来他们会将继续保持下去,并为其他开发者带来的正面影响。 标明每个commit 修改什么,帮助reviewer快速了解情况 此时就不要吝啬你的称赞了!

    3.4K53

    学界|如何捕捉冗长讨论里的目标信息?谷歌推出最大标注数据集

    AI科技评论按:很多读者在思考,“我AI科技评论的距离在哪里?”答案就是:一封求职信。 信息爆炸时代,如何在浩瀚如海的网络中找到自己的需求?...作为一名雷锋网编辑,信息搜集分类是日常工作中极为耗时的一件事。谷歌推出的新方法能否解决这一问题?...从这个数据,超过10万条的评论由众包编辑单独注释其话语类型关系。连同众包编辑的原注释,我们还提供标注任务指南,供编辑们使用帮助他们从其他论坛收集数据对任务进一步细化。 ?...论文摘要 在这项工作中,我们提出了一种新的方法将在线讨论中的评论分类成一些粗糙语料,是为了在一定规模上更好理解讨论这个目标的实现。...实验结论 团队使用了一种新的话语行为的分类,我们推出一个从Reddit上数千个社区采样,最大的人工标注的数据集的讨论,在每个线程上的每个评论根据话语行为关系注释

    871140

    占用网络:通过学习粒子动力学进行4D重建

    在本文中,研究人员描述了一种从图像或稀疏点云进行密集4D重建的新方法。 在我们的世界中进行交互导航的智能代理必须能够以3D推理。因此,近年来,对于基于学习的3D重建引起了很多兴趣。...一方面,这种表示具有足够的表现力,以使我们可以表示现实世界中出现的所有复杂几何形状。另一方面,该表示应与现代机器学习技术(特别是深度学习)一起很好地工作。...当然,我们可以单独对待每个时间步骤,并将其应用到网络中。但是,这将非常慢(毕竟我们无法重用先前时间步长中的信息),甚至更糟的是,我们在各个时间步长之间没有任何对应关系。2秒后指尖在哪里结束?...方法 我们在该项目中的主要见解是,我们可以分别表示3D实体的形状运动(“解缠结”)。我们不仅使用占用网络,还使用两个网络:占用网络速度网络。...但是,如果给出了它们,我们可以通过将点跟随矢量场的位置与应该去的位置进行比较来轻松地合并它们。 总而言之,关键思想是我们解开3D对象的形状运动。

    65510

    【译】Google 官方文章——如何去做code review

    当达成共识变得特别困难时,reviewer作者需要进行面对面会议,而不是仅仅试图通过cr的注释来解决冲突。(不过,如果这样做,请确保将讨论结果记录在CL的评论中,以供将来的读者阅读。)...reviewer特别注意一下过度设计。鼓励开发者解决他们知道现在需要解决的问题,而不是推测将来可能需要解决的问题。...这些注释是否真的必要? 通常注释是解析这段代码为什么存在的时候是相当有用的,而不应该去解释某段代码正在做什么。如果代码本身不能解释清楚的话,意味着它更加需要简化了。...但对于大部分注释来说是用来说明那些不包含在程序本身但资讯,比如说为什么要这样子做的理由 查看该CL之前的注释也很有帮助,或许有一个todo项目现在可以一处、一个评论建议为什么不要进行这种更改等等。...其实透过简单的一句话让对方知道哪里做得很好,未来他们会将继续保持下去,并为其他开发者带来的正面影响 标明每个commit 修改什么,可以帮助reviewer快速进入状况 此时就不要吝啬你的称赞了

    73630

    Django如何开发网页

    以下是一些建议:1)变量名:变量名具有描述性,使用驼峰命名法,首字母小写,每个单词的首字母大写。2)函数名:函数名具有描述性,使用驼峰命名法,首字母小写,每个单词的首字母大写。...3)类名:类名具有描述性,使用驼峰命名法,首字母大写。4)模块名:模块名具有描述性,使用名词,首字母大写。3.1.3 代码注释代码注释是解释代码含义的重要手段。...良好的注释可以帮助他人更快地理解代码,以下是一些建议:1)简洁明了:注释简洁明了,清晰地阐述代码的功能实现思路。2)及时更新:注释应与代码同步更新,当代码发生变化时,及时修改注释。...五、Django代码实例分析5.1 实例概述在本节中,我们将通过一个具体的Django项目实例来详细分析Django代码的编写方法技巧。该项目为一个简单的博客平台,用户可以浏览、评论发布博客。...综上所述,Django性能优化与调试对于提升应用性能保障代码质量具有重要意义。开发者熟练掌握相关技巧方法,不断提高自身开发水平。

    11720

    所有程序员都应该遵守的11条规则

    2、对代码而言,“聪明”是“清晰”的敌人 在写代码的时候,我们努力保持书写的代码清晰易懂。...当我跟Bob Martin在一起时,他说: “你写的每个注释,都代表着你表达能力的欠缺“ -整洁代码:敏捷软件艺术手册 这并不是说一点注释也不写,但通常我们可以通过一种更好的方式——命名来避免。...注释仅在命名不能有效表示变量或方法的意图时才真正需要。此时的注释表达了不能用代码表达的真实意图。...注释没有随着代码更新的倾向,而这是很危险的,因为它们会将你带入歧途。 你会查检每条注释与之对应的代码,确保代码是在做注释说的事么?如果是的话,写注释还有什么用?如果不是,你怎么相信注释说的是对的?...真他妈麻烦,所以最好还是尽量别写注释了。 OK,喷子们,在下面的评论区里留下你们的“口水”吧,但我会无视你们的。

    75380

    《Effective Java》中学到的思想

    收获 在重点或疑问的地方,做出标记注释 在读《Effective Java》时,对于前10条建议,我并没有理解得很深刻,因为我只是简单地拿笔在书上划下重点的句子而已。...我也感觉到了问题,后来在重点或疑问的地方,做出标记注释,对于问题的理解提升很大。 虽然这是一个很愚蠢的问题——连小学一年级的学生都知道,但是我却刚刚体会到这样做的好处。...然后我就会问自己:为什么对于基本类型对象类型,要采取不同的排序方法呢?快速排序的调优,体现在哪里?归并排序的改进,又体现在哪里?...在查看源代码的基础上,我又发现JDK 7采用了一种Dual-Pivot Quicksort的快排方法,就会思考这个算法好在哪里?...在查看源代码的过程中,我发现注释中有个API的设计者是Josh Bloch,我就Google了一下。我才注意到他就是这本书的作者啊!

    69031

    【C语言】初识C语言(常见的C语言概念)

    于是美国标准学会就出台了标准ASCLL编码,C语言就是采用的ASCLL码,完整ASCLL码表如下: 注意:我们没必要记住表中每个字符对应的数字,只需要记下一下几点: 字符0–9对的ASCLL...,遇到\0就结束,\0不会计入长度,也不会打印出来,那字符串字符的区别在哪里呢,请看演示: #include int main() { char arr1[] = { 'a',...那么注释怎么写呢?有两种方法: 1.注释放在/…/ 之间,内部可以分⾏。...比如: 可见,它可以注释一行也可以注释多行,但是它不能嵌套注释,比如说: 可以看见注释并没有成功,因为第一个/* 第一个 */配对了,并不是第一个 /*最后一个 */配对导致嵌套失败...,下次讲C语言的数据类型变量,如果今天的内容有不懂的还请在评论区留言,当然,还有许多不足的地方也请大家多多指正,谢谢!!!

    9610

    beego利用casbin进行权限管理——第四节 策略更新

    特别是对于权限设计的处理方式,casbin是尽量用它自己的查询方式,因为那是直接查(增、删、改)内存(map),而不应该去查(增、删、改)数据库,这点必须避免,这个系列文章中很多犯这样的错误,阅读时,应该根据自己的场景...casbin的rbac_api.gomanagement_api.go中的方法,似乎分成几个“层次”:比如addroleaddpermission,这种专用的;AddNamedPolicy类似这种通用的...只能用 先取出user的所有角色,再循环,取出每个角色具备的权限。   ...比如,对于一个文档,全部权限规定为1,评论为2,只读为3,不允许为4。...接下来有个不成熟的想法:把casbin的example里的confcsv一一对地放到一个文件中,加上注释,可能的话配上增删改等方法

    1.7K10

    科学软件十条简单编程原则

    我提出了这10条简单的规则,希望通过将软件工程最佳实践应用于研究工具文档,您可以创建最具可用性影响力的软件。 规则1:在编码时编写注释 注释是软件文档中最重要的一个方面。...在一天结束时,人们(包括您自己)需要能够阅读理解您的源代码。好的变量函数名称可以极大地提高可读性,尽管它们不能完全替代注释。虽然你的代码在没有评论的情况下可能会很明显,但其他读者可能不会那么幸运。...将注释解释视为您的实验室笔记本:它们可以帮助您在事后很久就记住您的思路。 编写注释的最佳方法是在编写代码时执行此操作。...因此,您的自述文件包括如何安装配置软件,在何处查找完整文档,在何处发布许可证,如何测试以确保功能以及确认。此外,您应该在自述文件中包含快速入门指南(如规则3中所述)。...至少,每个函数都应记录其输入输入类型,记录其输出输出类型,以及记录的任何错误。对象应该描述它们的方法属性。最好为API文档使用一致的样式。

    88020

    你的pcr为什么定量不出来?

    这些方法都有不同的优缺点,比如TaqMan法虽然重复性高,但是它的成本也比较高。童鞋们可以根据自己的实验室条件预算进行选择。...一些要注意的习惯问题: ·RNA提取时,所有用具应该去RNsae处理; ·离心的时候应该4℃预冷; ·RNA提取结束后短期可存于-20℃冰箱,长期置于-80℃,避免反复冻融 ·提取的RNA要有较高的完整性纯度...I时避光。...CT值出现晚 PCR引物过长:产物长度一般选择80-150bp PCR各反应成分的降解或加样量不足 ·溶解曲线不齐,多个主峰 引物浓度不适当:注意上下游引物的浓度配比 引物设计问题:避免引物二聚体发夹结构出现...当然啦,真的遇见问题的时候,我们也不要气馁,要积极的思考问题出在哪里,并在接下来的实验中改正。如果遇到什么不懂的或者有什么想法,欢迎在下方滴滴我哦。希望大家一切顺利,多发paper!

    1.8K40

    如何正确理解VOC(客户之声)?

    他把选择缩小到3个,然后上网看评论。发现其中一个品牌在某评论网站上有200多条相关信息评价。平均分在8.6(总分10)左右,看上去似乎很不错。大多数评论都非常正面,但也有少数非常负面。...这家企业应该去关注那些非常负面的评论吗?有时候客户的不满来源于不切实际的期望或不恰当的使用方法。...图片如今的消费者有太多可以发表自己意见的场所,卖方自己的网站,评价评论网站,博客,Facebook等等等等。...比如,国外某机构对Facebook用户所做的一次调研显示Facebook上来自“朋友”的评论最有影响力。所以不管企业愿不愿,它都必须监控社交传媒上正在发生的事情。...再加上有时候有些在线评论评价受到某些因素的操控。于是VOC(客户之声)很不幸地变成了客户噪声。 其实,客户之声并不意味着每个大大小小的决定都要得到客户的认可。

    63520

    谷歌智能助手入驻三款音箱,出门问问海外版居然国内完全不一样

    李林 编译整理 量子位 报道 | 公众号 QbitAI 谷歌秉承着让Assistant“无处不在,随叫随”的理念,今天在德国柏林的IFA电子展上宣布,今年会有三家第三方音箱用上Google Assistant...不过,这家公司在国内国外似乎走了两条完全不同的路线,上周面向国内发布的音箱搭载的是问问自己的软件,外观也上面的TicHome Mini完全不一样。 ?...除了这三款音箱之外,Google还宣布自己的智能助手会LG的家用电器整合起来,比如洗衣机冰箱吸尘器。衣服洗好了没、吸尘器该去干活了,你可以跟Google Assistant沟通。...至于搭载了Google Assistant的这些音箱主要卖往哪里,Google说主要是美国、英国、澳大利亚、加拿大、德国、法国。

    71180

    使用自定义注解实现接口参数校验

    在本文的示例中,仅实现了对某一个字段的校验,安全性并不高,实际项目中,可以采用多字段加密的方式,来保证安全性,原理和文中是一样的. 2.java 注解介绍 Java Annotation是JDK5.0引入的一种注释机制...,生命周期是运行时保留.此外,注解有一个类型为string数组的参数,用来表示当前方法允许的source列表. 5.2.编写注解解析器 其实一开始我在这里纠结了许久,因为我不能理解一个注解应该在哪里以什么方式调用...按照我的思路,每个注解应该有一个字段(或者类似的东西),来指示应该去哪里调用这个注解的真正使用....拿传入的source参数这个注解的属性sources列表一一匹配,有匹配上的则允许请求,无匹配值则返回错误信息. 5.3.实际使用注解 5.3.1.首先配置这个拦截器,拦截status接口 package...ChangeLog 2019-01-20 完成 以上皆为个人所思所得,如有错误欢迎评论区指正。 欢迎转载,烦请署名并保留原文链接。

    1.8K10

    接口测试平台代码实现130: 全局变量-9

    答:应用插入,需要使用特殊标记的占位符,所有区域统一风格。...但因用例库中多接口直接的返回值插入功能 本功能 类似,所以风格必须区分,否则进行替换特殊占位符的时候,遇到同名变量,就不知道该去替换的是前一个接口的返回值还是全局变量了。...答:拿接口库接口调试来举例,前端P_apis.html 把带有~变量名~全局变量的用户请求体,后台views.py中 对其进行了整理实际发送(如果是用例库则还要去run_case.py中) 我们在请求体获取后...所以我们 最好组件化,写一个公共的替换方法,把 host/url/请求头/请求体中 扔进去,然后给你返回 替换后的。...虽然这个方法比较复杂,但是只要写的很好很稳定健壮,考虑好容错性等因素,注释写好,那么后面会非常省心。 好,设计上暂时就先水到这里了,牛b的同学已经开始自己尝试实现了。

    25520

    第06步《前端篇》第2章打造游戏界面第1课

    中剧中绘制文本; 理解不能变化的常量在程序中的作用价值。...HTML是富文本标记语言,这门语言的主要作用在于标签构建页面结构。每个HTML标记都是成对出现的,它们都具有相同的格式:......单行注释以两个斜杠(//)开头,放在代码行上方。如果注释内容不多,也可以把注释放在行尾。...小结 应用层的开发就是这样,要深入学习、了解技术栈中接口的主要功能及具体参数要求,了解边界在哪里,知道哪些能做,哪些不能做,这样在开发功能时才能得心应手,遇到问题时才能想到问题可能出在哪里。...二,在下方评论区提问。软件问题复杂的话需要提供代码链接,优质问题作者一定会认真回答并精选出来。 三,在评论区查看其它人的提问。 感谢理解支持。

    1.1K20
    领券