写代码一些会让同事感谢叫爸爸的注释

最新推荐文章于 2024-07-20 17:12:48 发布
最新推荐文章于 2024-07-20 17:12:48 发布
阅读量158 收藏
点赞数 2
文章标签： python java javascript c++ 算法
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_62415132/article/details/137967046
版权

1、代码头

为代码文件添加代码头可以让这段代码在下一个人或者个人回看的时候更清晰这段代码做了什么工作，方便代码传递以及复用。

同时对写代码也起到了一个主题提醒的作用，写代码的目的也更清晰

2、方法思路步骤

在import block下面添加一段注释进行思路梳理，有助于自己写代码时候思路清晰，也有助于其他人使用or修改代码的时候明确以下代码具体以什么样的思路路线去做的处理or完成任务

3、代码块注释

声明每个代码块之后，添加一个注释来细化上面提到的方法思路

4、语句注释

在有必要or思路有拐弯or用法不常见的代码后面单独添加注释来解释代码功能

做完这些，下个月的自己以及同事可能感谢的会跪下来叫你爸爸

不是很强 但是很秃
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
编写代码的软件用什么编写的_您到底是为谁编写代码？
编程故事的地方
01-24 865
编写代码的软件用什么编写的 特别感谢许多阅读本文并为我提供有用反馈和建议的人：Anya Roltsch，Frank Schubert，Olga Hollister，Ravi Varshney，Ashansu Pant，Marcus Blankenship，Sandra Jones，Taylor Davenport。 编写代码是非常个人的行为。 软件开发人员在锻炼时会考虑要在工作中，在汽车...
您到底是为谁编写该代码？
编程故事的地方
01-24 124
特别感谢许多阅读本文并为我提供有用反馈和建议的人：Anya Roltsch，Frank Schubert，Olga Hollister，Ravi Varshney，Ashansu Pant，Marcus Blankenship，Sandra Jones，Taylor Davenport。 编写代码是非常个人的行为。 软件开发人员在锻炼时会考虑要在工作中，汽车中，在家中编写的内容，有时甚至梦到...
用C语言写一个查单词的小demo
热门推荐
m0_47068593的博客
07-03 4万+
用C语言写一个查单词的小demo #include <stdio.h> #include <string.h> #include <stdlib.h> int main(int argc, const char *argv[]) { // 用只读的方式打开我们的单词库 FILE *fp = fopen("dict.txt","r"); if (NULL == fp){ perror("fopen"); return -1
Apache DolphinScheduler 在叽里呱啦的实战经验
数据之路
06-24 2677
作者简介：wade，叽里呱啦攻城狮一枚，曾就职于苏宁，同花顺等，9个月大粿粿的爸爸。 前言 “工欲善其事，必先利其器” 在2019年进行数仓建设时，选择一款易用、方便、高效的调度系统被摆在非常突出的位置，感谢前同事马振洋同学和杨孟霏同学的付出，最终有缘选择了DolphinScheduler的前身EasyScheduler (后面使用ES代替)，版本为1.1，差不多成了第一批在生产上使用海豚调度产品的吃瓜群众，同时我们也在密切关注社区的变化，并成功...
Spring 微服务实战
GitChat
11-06 5934
内容简介 本书以一个名为 EagleEye 的项目为主线，介绍云、微服务等概念以及 Spring Boot 和 Spring Cloud 等诸多 Spring 项目，并介绍如何将 EagleEye 项目一步一步地从单体架构重构成微服务架构，进而将这个项目拆分成众多微服务，让它们运行在各自的 Docker 容器中，实现持续集成/持续部署，并最终自动部署到云环境（美亚）中。 针对在重构过程中遇到的各种...
腾讯后台面经大全（整合版）
Java技术江湖
07-24 2万+
来源：牛客网 腾讯提前批一面 Tcp如何实现可靠传输 如何处理syn flood Os如何实现内存管理 进程间调度和上下文切换怎么实现 系统调用或者说中断的过程 软中断 硬中断 内存延迟分配怎么实现的 了解vfs吗 了解云计算，虚拟化吗 内存分配的系统调用是什么 Linux里的Rcu知道吗 Linux里有哪些锁 有哪些自旋锁，分别是怎么实现...
这些年，我身边的那些人和事
Java's paradise
03-23 1万+
引言 　　 　　2013年的8月13日，群主打开自己的QQ，建立了第一个技术交流群，也就是现在的交流一群。 　　时光飞逝，转眼之间，3年半已经过去了。 　　当初建群的时候，群主才工作不到两年，期间借着业余时间，写了一个设计模式的系列，因此吸引了一批同道中人一起学习。为了给大家一个一起交流的地方，群主便顺手建了一个QQ群。 　　谁曾想，3年半过去了，这个无意之中建立的QQ群，不止见证了群主的成长，也
清华梦的粉碎—写给清华大学的退学申请 /王垠
wzy的博客
08-20 4344
今天无意中同事给我提到一个人，那就是王银，在网上看了关于他的神话，网上对他的言论还是很大的，这个人我不能评价他是个什么样的人，但他是我很值得敬佩的人。很赞。 也许中国目前的教育就是这样的，我虽然不是什么牛逼的学校出来的，没吃过猪肉，难道还没见过猪跑么？当下就是做好自己，我妈一直跟我说，你要做一个善良，勇敢的人，当一个人有危险的时候，要确保自己安全的情况下，你才可以去救别人。把当下的事做好，再去实
OSChina 周四乱弹 ——因为女同事衣服穿的薄 所以老板发现我没上班？
weixin_33912453的博客
11-23 316
2019独角兽企业重金招聘Python工程师标准>>> ...
手写数字识别OCR数据集以及识别代码附有详细注释
10-20
比如，代码可能会解释如何加载数据集、定义模型结构、设置超参数、编译模型、进行训练以及评估模型性能。每个函数、变量和操作都有详细的注释，使得初学者可以轻松地跟随代码流程，逐步理解手写数字识别的全过程。 ...
什么时候应该避免写代码注释？
08-03
在编程实践中，代码注释被认为是一种重要的辅助工具，帮助开发者理解和维护代码。然而，"什么时候应该避免写代码注释?" 这个问题提出了一个反常规...记住，优秀的代码应当"读如诗，写如散文"，让代码自身讲述它的故事。
程序员佛祖代码注释.txt
09-14
程序员佛祖代码注释，佛祖保佑，代码无BUG
代码注释器
08-06
2. **代码解析**：注释器会解析代码的结构，包括变量定义、函数调用、循环结构等，并以图形化的方式展示，便于用户直观地理解代码流程。 3. **智能注释**：它能够自动生成代码注释，解释代码的功能和目的。这对于...
代码中到底应不应当写注释？
10-25
注释的确有其用途，但大部分情况下，程序员在滥用注释。我是反对夹杂在代码间的注释的，我认为注释应当从代码中独立出来——通常被称为文档。
使用Python的Turtle库绘制动态风车
最新发布
爱写代码的小朋友
07-20 190
python绘制风车
华为od机试真题 — 代表团坐车(Python)
学习,你不是一个人在战斗 ～ 961302305（QQ,微信）
07-17 595
【华为od机试真题 】代表团坐车(Python) 某组织举行会议，来了多个代表团同时到达，接待处只有一辆汽车可以同时接待多个代表团，为了提高车辆利用率，请帮接待员计算可以坐满车的接待方案输出方案数量。
【Python如何将字符串连接在一起并使用`join()`方法】
qq_36253366的博客
07-19 257
方法是字符串对象的方法，而不是列表或元组等序列类型的方法。因此，你需要先指定一个用作分隔符的字符串，然后调用这个字符串的。方法将字符串连接在一起，你需要首先确保这些字符串被存储在一个序列类型中（如列表或元组），然后调用这个序列的。方法是一个字符串方法，它用于将序列（如列表、元组等）中的元素以指定的字符连接生成一个新的字符串。列表中的所有字符串元素使用空格作为分隔符连接成一个新的字符串。方法，并将你想要作为分隔符的字符串作为参数传递给。方法，并将包含要连接字符串的序列作为参数传递。
IPython 日志秘籍：%logstate 命令全解析
2401_85812026的博客
07-17 579
logstate命令是 IPython 日志系统的重要组成部分，它帮助我们掌控日志记录的状态。通过本文的介绍，你应该对如何在 IPython 中使用%logstate查看日志状态有了更深入的理解。记住，合理利用日志系统，可以让你的数据探索过程更加透明和可追溯。本文详细介绍了 IPython 的%logstate命令，包括其基本概念、基本用法、输出解析以及实战示例。希望本文能够帮助读者更好地利用 IPython 的日志系统，优化数据探索和科学计算的工作流。记住，掌握%logstate。
上述代码写注释
05-27
好的，下面是带注释的冒泡排序Java代码： ```java public class BubbleSort { public static void main(String[] args) { int[] arr = {5, 4, 3, 2, 1}; bubbleSort(arr); // 调用冒泡排序方法 for (int i : arr) { System.out.print(i + " "); } } /** * 冒泡排序方法 * @param arr 待排序数组 */ public static void bubbleSort(int[] arr) { int n = arr.length; // 外层循环控制排序轮数 for (int i = 0; i < n - 1; i++) { // 内层循环控制每轮排序的次数 for (int j = 0; j < n - i - 1; j++) { // 比较相邻元素的大小，如果前一个数大于后一个数就交换它们的位置 if (arr[j] > arr[j + 1]) { int temp = arr[j]; arr[j] = arr[j + 1]; arr[j + 1] = temp; } } } } } ``` 这段代码中，我们对冒泡排序方法和主函数分别添加了注释。在方法的注释中，我们说明了方法的作用，即对传入的数组进行升序排序；在内层循环的注释中，我们解释了循环控制的是每轮排序的次数，从而把最大的数“冒泡”到数组的末尾；在交换元素的代码块中，我们注释了这段代码的作用，即交换相邻元素的位置。这样，代码的可读性和可维护性都得到了提高。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值