# 我的2023年度工作总结

因为最近事情比较多，比较忙，迟来的工作总结，回顾23年，对于我是充满忙碌、变化与挑战的一年，这一年曲折坎坷，终是轻舟已过万重山。

2024.3.10更新：拿到了23年度的某手洛子峰奖（全都仰仗大佬们）、有幸拿到了所属线的踏实进取奖，瞬间感觉自己一年的付出得到了认可。

# 2023 Q3、Q4所参与的项目：
## 1. 内部网络工具APP：
- **角色**：Android研发支持 
- **工作内容**：编写Android底层网络信息与信号强度的检测工具类，封装底层接口
-  **产出**：协助了内部工具网络检测功能性技术方案的验证
-  **自我评价**：后半年Android原生侧需求较少，因此并没有很多的工作内容，但参与的网络检测功能性技术方案的验证较为顺利。
## 2. 班车系统：
- **角色**：技术主R
- **工作内容**：完成了新版本班车设备系统的研发工作，完成班车APP与管理后台的研发，攻克实际业务场景下的痛点
- **产出**：解决了班车系统在极端弱网环境下无法使用、现场人力维护成本高的痛点，完成了上线和交付工作，业务运行相对稳定。
- **自我评价**：在此前没有接触过车机设备的情况下，接手这个项目还是比较有挑战性的，在过程中也踩了非常多的坑，也学到了很多，并且第一次意识到了产品和沟通管理对一个项目的重要性。对个人来说，经过这个项目，意识到自己还有很多需要改进的地方，是一次很好的成长。（我自己一个人做客户端+后端+主R，感觉还是蛮nb的）
## 3. 会议室预约屏：
- **角色**：技术主R
- **工作内容**：
    1. 开发会议室预约屏信息展示优化、自动巡检、设备自动开关机等功能
    2. 开发会议室预约屏管理平台
- **产出**：
     1. 完成累计一千多会议室的预约屏全量上线工作
     2. 上线会议室预约屏自动开关机、自动巡检策略，降低设备故障率到10%内
     3. 参与开发并上线了会议室预约屏管理平台，提高会议预约屏维护效率
- **自我评价**：预约屏的相关需求迭代开发和上线都相对较为顺利，也较为快速，个人对自己在预约屏项目上的表现较为满意。
## 4. 智能化会议室：
- **角色**：研发支持
- **工作内容**：
  1. 实现会议室人体存在、开关数据的投票算法和数据入库。
  2. 完成会议室智能化电视集控的开发
- **产出**：协助完成了会议室智能化数据看板的搭建工作，完成了电视集控的灰度上线
- **自我评价**：
     1. 在数据看板中，对于大型数据的处理此前没有相关经验，外加同时期精力相对有限，导致初期项目进展并不顺利，数据入仓代码较为混乱，集成开发较为困难，并且上线测试后还出现了部分数据不准的问题，数据库内写入超千万量级的数据维护起来也很费劲，然后替换了旧有的数据格式，替代为相对简洁的投票机制，希望在24年度无极看板能够完美上线运行。
    2. 在会议室集控项目中，因此前有对接绿米SDK的经验，因此相对开发和灰度上线都相对较为顺利，同时还完成了海信电视APP集控的方案测试验证，因此相对较为满意。
## 5. 内部资源管理平台（CMDB）：
- **角色**：后端研发支持
- **工作内容**：
  1. 基于Casbin实现平台权限管理和审计模块的开发。
  2. 实现网络管理平台的CMDB资源Excel模板文件的上传与下载
- **产出**：
    - 完成了权限管理模块的研发与上线，并对服务进行了解耦和优化
    - 完成了CMDB资源Excel模板文件的上传与下载功能。
- **自我评价**：
     1. 在权限管理中，自己之前没有接触过RABC模型和Casbin开发，通过这次的权限管理需求，首次了解并且学习了RABC模型和Casbin的使用，并且独立解决了多容器场景下Casbin数据无法正常同步的问题，对自己有较大的成长。
    2. 在会议室集控项目中，因此前有对接终端传感器的经验，因此相对开发和灰度上线都相对较为顺利，同时还完成了电视APP集控的方案测试验证，因此相对较为满意。

# 对自己的评价
> **关键字**：成长、变化

自入职后的23后半年学到了非常多的东西，不仅仅包括技术上的，也包括很多通用性的能力，包括文档撰写、项目管理、沟通等。在工作的半年，自己的提升非常大，感觉自己这半年是充实且充满成长性的半年。

但是半年中也发现了自己在职场中存在的一些缺点和不足，包括沟通能力不强，不能很好的主动和人进行有效沟通；信息传递意识不强，很多信息不能及时同步到上级与项目相关方；不能很好地管理自己的精力与排期；偶尔会管理不好自己的压力情况等，希望下年度能够有所进步。

总的来说23年的工作个人打分：7分/10分，欠缺3分为沟通一分、压力管理一分、技术目标未达到个人预期一分。
# 工作中迷惑的地方
**排期问题**：在业务中经常会遇到无法预估排期的问题，先前并没有相关经验，单靠调研并不能准确预估排期时间，排期多了和少了都会有问题，反而会造成压力，导致项目效果不理想。
# 24年度的规划
1. **技术规划：**
-  在维持正常业务开发的基础上，侧重于后端技术的扩展与提高，学习分布式、微服务、RPC等后端技术栈，弥补后端技术短板的情况
-  在安卓侧想办法整理出较为完善的个人技术架构，包括BaseLauncher、Iot应用快速搭建脚手架等，提高开发效率
2. **通用能力规划**：
-   适当处理好自身心态，寻求压力与工作平衡点，锻炼与人沟通技术。
# 24年度目标：
- 技术上熟练后端各类技术栈，研究各类后端架构，并编写一些技术性验证demo发布到博客或Github。
- 通用能力上锻炼自身沟通能力。

2023工作总结

又到一年毕业季，新的韭菜要进入社会被噶了，这里写篇博客给一些自己短浅的建议供计算机相关专业的学弟学妹们参考。
> 免责声明：因本人经验短浅，本文章仅供计算机相关专业参考，对其他专业可能不具有参考价值，并且本文章仅为本人建议，仅供抛砖引玉，引发读者自身思考，读者的个人决定与本人无关。
# 毕业——考研？就业？考公？


## 选择
毕业后对于普通的大多数来说，大家无非就三种去向，考研、就业和考公，这里我结合我自己的一些经验分享一下我的看法。

这三种选择建议最好**结合自身情况与调研实际情况**去决定，多去咨询相关学长学姐去了解就业/考研/考公的实际情况。
> 
> 考研/考公 本人没了解过，这里不作过多篇幅，但是如果你不知道自己要干啥，而是随大流去考研/考公，并且自己的自制力没有那么好，那么建议滚去就业，不要浪费自己的时间，并且各个厂很少有招聘往届生的机会，也就是最好不要指望考研没上继续二战，最后再找工作，机会只有一次。

### 就业
对于学计算机的同学来说，若本科就业，首选央企、互联网中大厂，次选国企小厂，不建议去外包（包括华为od）。

- **现实情况**：现在计算机就业市场存在饱和，各个中大厂逐渐减少校招名额和比例，各家都在降本增效，拿到中大厂offer的难度与日俱增。同时很多下岗大厂员工投身进入所谓的“程序员速成班”，越来越多不明觉厉的人进入互联网企业做起了外包，导致大厂的用人倾向逐渐倾向外包化，在可预见的未来互联网行业只会越来越卷。
- **自身条件**：进入中大厂的水平要求较高，如果你大学三年都没有很好地积累非常扎实的技术栈和较多的项目开发经验，那么卷中大厂绝对不是一个好的选择。
    - 如果你熟悉Java、Python、Go、Js等任意技术栈（有熟练理解其底层原理），并且至少刷完了力扣100题，那么好好准备可以冲大厂了。
 - **中大厂/央企/国企/小厂 区别：**
    - 本质上不论去哪种性质的企业，作为程序员，干的活基本都是差不多技术水平的（算法岗除外），面试造火箭，工作拧螺丝就是这个道理。
    - 中大厂的优势：平台大、相对机会多，流程规范，优势项目经验多，大厂经验会非常宝贵。
    - 中大厂劣势：压力大、裁员可能高、没有个人时间
    - 中大厂适合什么人：技术水平高、喜欢打拼、想赚钱
    - 央企/大型国企优势：平台大、环境相对轻松、稳定，福利高
    - 央企/大型国企劣势：门槛高
    - 央企/大型国企适合什么人：学习成绩优异、党员、想进体制但是不想考公，家里有背景。
    - 小厂/边缘国企的优势：环境轻松、门槛低、部分有后发潜力
    - 小厂/边缘国企劣势：待遇低、技术质量低、对个人提升很难没有促进
    - 小厂/边缘国企适合什么人：技术力差，学习中等，喜欢轻松的生活工作
### 思想
我们大学的教育与社会是极其割裂的，在脱离大学进入社会前，一定要转变自己的思想。自信、善于表达自己、适度地装逼表现自己，要比闷头苦干的人更适合社会节奏。

同时学会与人沟通，换位思考，与人沟通的能力在职场中远大于个人技术能力，在实际职场中，沟通占7分，技术占3分，但请注意对于校招生来说，技术依然是首选项，沟通能力仅是能助我们走的更远，不代表技术就不重要。

学会大胆表现自己，不要担心在面试官或领导面前表达出来会班门弄斧，如果你在大学期间加入了实验室，并且取得了一些A类赛事的国奖，熟读了一门或几门技术栈，有自己独立开发项目的能力，那么你已经超越了至少50%的同龄人（包括985/211），如果你有这样的能力，你是很牛逼的。

推荐一本书：《跃迁》https://book.douban.com/subject/27078435/

### 就业准备？
1. 渠道
    
    Boss直聘（相对最靠谱）、智联招聘（国企、传统企业偏多）、牛客（校招、实习）、实习僧（实习）
3. 简历
    
    简历是非常重要的一个点，简历的好坏直接决定了面试官对你的第一印象，对于计算机专业的来说，简历应该包含下面的几个要素：
-  **个人基本信息**，（学历、专业、绩点、邮箱、电话、微信、个人照片），个人信息尽量直观、精简，**不要写学生班干部经历什么的，技术岗位没人管你是不是班干部**
-  **掌握技术栈**：视你投递的岗位和个人技术积累而定，比如你投递java后端，那么技术栈就尽量写SpringBoot、Mysql等，如果投递的是Web前端，就写写熟悉Js、Vue、React等技术栈。
-  **项目经历**：这里最为重要，项目经历尽量写的一眼能看明白**你在项目里做了什么、有什么成就**，可以参考STAR原则去写，即项目是什么？你的角色是什么？你做了什么？过程是什么？结果是什么？这样写出来的最为直观。
![](https://picx.zhimg.com/80/v2-ba5e57c18bcf05240750085008251576_1440w.webp?source=1def8aca)
-  **获奖**：  可以写写自己获得的省级以上奖项，**校级以下的没必要写**，没有任何含金量
-  **其他经历**：包括社团主席、赛事组织负责人等可以写写，如果是班干部之类的任职，没有必要写。
4. 心态
   
   放平心态，找工作70%靠的是运气，30%靠的是实力，很多时候你可能比其他人技术更好，能力更强，但是面试官选择了另一个人，挂了你，不是你不行，而是刚好另一个人运气好，更贴合面试官的喜好和岗位匹配度。本人之前校招的时候三个月投递了380+公司，面试了一百多场，最后也才拿到了四五个offer，很多时候放宽心去做就好了。
>    但行好事，莫问前程。
   
>    多在几颗树上吊死，总能成一个。
5. 方向选择：
    前端？后端？客户端？
    
    就现在个人感觉来说，后端和前端的岗位还是蛮多的，AI算法岗对本科几乎没有任何机会，因此推荐继续卷前端后端，客户端发展有局限性，即使校招进去后也需要转前后端，否则容易被淘汰。测试岗位不推荐，但是可以考虑，在大厂中测试岗位相对其他来说门槛会低一点，但是对个人提升也比较有限。
7. 技术
    
    背八股已经是基本要求了，更多注重技术与业务结合，思考一个算法或代码特性可以在什么场景中使用会更有加分。
-   力扣算法
-   拿得出手的项目（学习STAR原则对项目进行整理）
-   熟读技术八股文

面临大学毕业——如何准备下一阶段？

最近闲来无事，折腾一下很久之前已经火完了的Stable Diffusion。这篇博客主要说明如何快速在有英伟达显卡的电脑上部署一份Stable Diffusion以及如何引入自己希望的模型。


本人部署用环境：
- CPU：AMD 5600X
- GPU：RTX3060
- RAM：32GB
# 1.确定相关网址
- SD-WebUI Github : SD经典UI仓库 https://github.com/AUTOMATIC1111/stable-diffusion-webui 
- HuggingFace: 用于下载各类所需模型,模型类型非常多 https://huggingface.co/
- civitai: 用于下载各类所需模型，更加直观一点，https://civitai.com/models/119012/bluepencil-xl


# 2. Clone仓库
打开你的Terminal，Clone SD WebUi仓库，在此之前请保证你的电脑有Git环境、cuda环境和python环境，关于如何安装Git请自行百度/知乎
```
git clone git@github.com:AUTOMATIC1111/stable-diffusion-webui.git
```

# 3.下载models
在HuggingFace或c站都可以任意选择一个model进行下载，我这里使用的是https://civitai.com/models/119012/bluepencil-xl 这个模型
![QQ截图20240108162956.png](https://s2.loli.net/2024/01/09/pM7yLniWgXel5b9.png)
下载完成后，将下载好的model文件放在.\stable-diffusion-webui\models目录下即可

# 4 启动SD
点击运行.\stable-diffusion-webui下的webui-user.bat文件，会弹出一个终端执行框，等待其自动配置完成即可

如果出现错误，请检查你的cuda环境和Python环境是否正常
![QQ截图20240109010854.png](https://s2.loli.net/2024/01/09/NhAgnoE6SlO8f4K.png)
# 5 成品
![QQ截图20240109010758.png](https://s2.loli.net/2024/01/09/NqYBh4aR5ofjLMX.png)

参考prompt：

anime, cute girl, wizard hat, kimono, thigh-highs, happy, dynamic pose, "HAPPY NEW YEAR!", 2024, pop font, landscape, sunrise, winter, red tone color, bloom effect, ambient occlusion, Bokeh, depth of field

speed：1360477511

快速部署一份自己的Stable Diffusion

# 问题描述

在Golang服务端使用Casbin作为权限管理的场景下，会增加多个Casbin实例来保证请求高并发和稳定性，但是与此同时会出现多个实例接口返回的数据不一致的问题，这种问题会严重影响业务使用。




# 问题原因

在Casbin的设计中，为了保证高并发下的可观性能，Casbin内置一个内存缓存，每当执行读数据的动作时，会先获取内存缓存中的数据，而不是数据库的数据。

因此在多实例场景下，当一个实例的Casbin数据发生变更时，其它实例的Casbin缓存并没有及时同步刷新，这就导致了当请求被分发到对应的实例上时，获取到的依然还是旧的错误数据。

# 问题解决

Casbin官方提供了一种可行的解决方法——Watcher机制，可以阅读对应文档[CasbinWathcer](https://casbin.org/zh/docs/watchers/)

文档中说明了casbin支持使用Redis、Kafka、zookeeper等中间件实现多实例之间的数据同步

我采用了成本较低的Redis作为Watcher，下面是我的代码参考：

- Watcher回调函数：
```golang
// 这是一个包装方法，方便传入Enforcer实例来实现回调中对casbin的操作
func ConsumeCallback(e *casbin.Enforcer) func(msg string) {
	return func(msg string) {
		zap.L().Info("enforcer update msg:" + msg)
                // 在接收到任意的权限变更后，刷新Enforce实例，达到刷新缓存的目的
		e.LoadPolicy()
	}
}
```
需要注意的是我们这里给到的回调函数必须是func(msg string)的形式，因为Casbin Watcher规定了回调到的方法只会给到一个Msg信息，剩下的需要我们自己处理。

具体的MSG信息官方文档并没有给出，不过我在实际测试过程中有总结到一个大的结构体对象可以供有需要的进行参考
```golang
// 回调中给到的msg的结构大概就是下面struct中定义的样子
type MSG struct {
	Method      string
	ID          string
	Sec         string
	Ptype       string
	Params      interface{}
	NewRules    interface{}
	OldRules    interface{}
	NewRule     interface{}
	OldRule     interface{}
	FieldValues interface{}
}

func (m *MSG) MarshalBinary() ([]byte, error) {
	return json.Marshal(m)
}

// UnmarshalBinary decodes the struct into a User
func (m *MSG) UnmarshalBinary(data []byte) error {
	if err := json.Unmarshal(data, m); err != nil {
		return err
	}
	return nil
}
```

- Casbin注册回调函数

```golang
func (c *CasbinOptions) Init(db *gorm.DB) (*casbin.Enforcer, error) {
	w, _ := rediswatcher.NewWatcher(viper.GetString("redis.addr"), rediswatcher.WatcherOptions{
		Options: redis.Options{
			Network:  "tcp",
			Password: "redis.password",
			DB:       "redis.iotDB",
			PoolSize: "redis.poolSize",
		},
		Channel: "/casbin",
		// 忽略容器自身发起的订阅消息推送，防止出现死循环
		IgnoreSelf: true,
	})

	adapter, err := gormadapter.NewAdapterByDB(db)
	if err != nil {
		zap.L().Error("casbin adapter init error:" + err.Error())
		return nil, err
	}
	e, err := casbin.NewEnforcer(c.Path, adapter)
	if err != nil {
		zap.L().Error("casbin enforcer init error:" + err.Error())
		return nil, err
	}
        // 设置RedisWatcher
	_ = e.SetWatcher(w)
        // 设置回调函数
	_ = w.SetUpdateCallback(ConsumeCallback(e))
	err = e.LoadPolicy()
	if err != nil {
		zap.L().Error("casbin policy init error:" + err.Error())
		return nil, err
	}
	_ = e.SavePolicy()
	return e, nil

}
```

完成后重新运行验证效果即可

Casbin多容器实例场景下数据不一致的问题解决

# 一、引言

## 代码整洁的重要性

代码整洁是软件开发中至关重要的一个方面。当我们编写整洁的代码时，可以提高代码的可读性、可维护性和可扩展性。整洁的代码易于理解，减少了他人阅读和维护代码时的困惑和错误。同时，整洁的代码也有助于减少bug的产生，提高软件的质量。




## 代码整洁的好处

1. 可读性：整洁的代码易于阅读和理解，减少了他人阅读代码时的困惑和错误。清晰的代码结构和命名规范使得代码逻辑更加明确，提高了团队协作效率。（简单来说就是要让一起协同工作的人能读懂你的代码，而不是一坨答辩）

2. 可维护性：整洁的代码易于维护。清晰的代码结构和模块化设计使得修改和扩展代码更加容易。通过遵循一致的编码风格和注释规范，他人能够更快速地理解代码的意图和实现细节。（

3. 可测试性：整洁的代码易于进行单元测试和集成测试。清晰的函数和类设计使得测试代码更加简洁和可靠。通过良好的错误处理和异常处理机制，能够更好地捕获和处理错误，提高代码的健壮性。

4. 可扩展性：整洁的代码易于扩展和重构。良好的代码结构和设计原则使得添加新功能或修改旧功能时能够保持代码的灵活性和可扩展性。通过避免代码的重复和冗余，减少了后续维护的工作量。


# 二、代码命名

在编写代码时，良好的命名是十分重要的，它能够提高代码的可读性和可理解性。以下是关于命名的几个要点：

1. 使用有意义的变量名：变量名应该能够准确地描述变量的用途和含义。例如，如果我们需要表示一个人的年龄，可以使用age作为变量名，而不是使用无意义的字母或数字。

2. 避免使用含糊不清的缩写：尽量避免使用难以理解的缩写，因为缩写可能会使代码的可读性降低。例如，如果我们需要表示一个订单的创建时间，可以使用creationTime作为变量名，而不是使用缩写形式如ct。

3. 统一的命名风格：在整个代码库中保持统一的命名风格是很重要的。例如，可以选择使用驼峰命名法或下划线命名法，并在项目中保持一致。例如，如果我们使用驼峰命名法，可以将一个变量命名为firstName，而不是first_name或FIRSTNAME。（一般对于Java、Golang而言我们更喜欢使用驼峰命名，而对于c/c++、python或脚本语言更喜欢使用下划线命名）

4. 避免误导性的命名：命名应该准确地反映变量或函数的用途，避免使用与其实际功能不符的名称。例如，如果我们有一个函数用于计算圆的面积，可以将其命名为calculateCircleArea，而不是calculateRectangleArea。

5. 避免使用中文拼音：很多初学者，特别是一些没有接触编程或从某些培训班体系出来的程序员会非常喜欢使用中文拼音来命名变量，这是非常不好的习惯，比如下面的代码：
    ```java
    String diYiXueQi  = "第一学期"
    ```
    如上面的变量，很容易引起误解，读者在阅读代码时，很难第一反应了解到这个diYiXueQi到底代表什么，而使用英文可以很顺畅地表达我们的想法。

# 三、函数

在编写代码时，函数是组织和封装逻辑的基本单元。函数设计的好不好直接决定了项目的鲁棒性和耦合度。
下面我通过python来举例什么是好的函数：

1. 函数的简洁性和清晰性：函数应该保持简洁和清晰，只关注单一的任务或功能。避免函数过于复杂和冗长，可以通过拆分函数、提取子函数等方式来简化函数的逻辑。

```python
# 不好的示例：复杂且冗长的函数
def process_data(data):
    # 复杂的数据处理逻辑...
    # ...
    # ...
    # ...
    # 复杂的数据处理逻辑...
    # ...
    # ...
    # ...
    # 复杂的数据处理逻辑...
    # ...
    # ...
    # ...
    # 复杂的数据处理逻辑...
    # ...
    # ...
    # ...
```

```python
# 好的示例：简洁清晰的函数
def process_data(data):
    preprocess_data(data)
    transform_data(data)
    analyze_data(data)
    save_data(data)
```

2. 函数的单一责任原则：每个函数应该只负责一个明确的任务或功能，并且只做这一个任务。这样可以提高函数的可重用性和可测试性，同时也使得代码更易于理解和维护。

```python
# 不好的示例：一个函数负责多个任务
def process_data(data):
    preprocess_data(data)
    transform_data(data)
    analyze_data(data)
    save_data(data)
```

```python
# 好的示例：每个函数只负责一个任务
def preprocess_data(data):
    # 数据预处理逻辑...

def transform_data(data):
    # 数据转换逻辑...

def analyze_data(data):
    # 数据分析逻辑...

def save_data(data):
    # 数据保存逻辑...
```

3. 函数的命名和参数选择：函数的命名应该能够准确地描述函数的功能和作用。选择有意义的函数名和参数名，可以让代码更易于理解和使用。

```python
# 不好的示例：函数名和参数名不具备描述性
def calc(a, b):
    # 计算逻辑...

# 不好的示例：使用缩写和无意义的参数名
def process_data(d):
    # 数据处理逻辑...
```

```python
# 好的示例：具有描述性的函数名和参数名
def calculate_sum(num1, num2):
    # 计算两个数的和...

def process_data(data):
    # 数据处理逻辑...
```

4. 避免过长的函数：函数应该尽量避免过长，超过一屏幕的长度。长函数难以理解和维护，可以通过拆分函数或提取子函数来减少函数的长度。

```python
# 不好的示例：过长的函数
def process_data(data):
    # 长长的处理逻辑...
    # ...
    # ...
    # ...
    # 长长的处理逻辑...
    # ...
    # ...
    # ...
    # 长长的处理逻辑...
    # ...
    # ...
    # ...
```

```python
# 好的示例：拆分和提取子函数
def process_data(data):
    preprocess_data(data)
    transform_data(data)
    analyze_data(data)
    save_data(data)

def preprocess_data(data):
    # 数据预处理逻辑...

def transform_data(data):
    # 数据转换逻辑...

def analyze_data(data):
    # 数据分析逻辑...

def save_data(data):
    # 数据保存逻辑...
```

5. 函数的注释和文档：为函数提供清晰的注释和文档，可以帮助其他开发人员理解函数的用途、输入和输出。注释应该简洁明了，解释函数的功能和关键步骤，而文档可以提供更详细的说明和示例。

```python
def calculate_sum(num1, num2):
    """
    计算两个数的和

    Args:
        num1 (int): 第一个数
        num2 (int): 第二个数

    Returns:
        int: 两个数的和
    """
    return num1 + num2
```

# 四、注释

注释是用来解释代码意图、提供额外信息并帮助理解代码的文字说明，注释的存在不仅仅是帮助别人理解你的代码，也是帮助未来的自己在维护时能够想起代码是干什么的（对于某些自己写的远古项目，如果你没有注释，那么那份代码可能只有上帝知道是干什么的）：

1. 注释的作用和使用场景：注释的主要作用是解释代码的意图、提供上下文信息以及帮助其他开发人员理解代码。注释的使用场景包括：

   - 解释代码的目的和功能。
   - 提供算法或逻辑的解释。
   - 强调特殊的注意事项或约束条件。
   - 提供对代码的修改或优化的说明。
   - 文档函数、类或模块的用途和使用方法。

   注释应该在需要解释的地方使用，并且应该与代码保持同步，以确保注释的准确性和有效性。

2. 注释应该解释代码的意图而非实现细节：注释应该关注代码的意图和目的，而不是详细描述代码的实现细节。代码本身应该尽可能自解释，而注释则应该解释代码为什么要这样做，以及代码的目的和预期结果。

   ```python
   # 不好的示例：注释过多的实现细节
   def calculate_sum(num1, num2):
       # 将num1和num2相加
       result = num1 + num2
       return result
   ```

   ```python
   # 好的示例：注释解释代码的意图
   def calculate_sum(num1, num2):
       # 计算两个数的和
       result = num1 + num2
       return result
   ```

3. 避免无用或误导性的注释：注释应该是有用的，不应该存在无意义或误导性的注释。避免在代码中添加显而易见的注释，注释应该提供额外的信息，帮助理解代码。

   ```python
   # 不好的示例：无用的注释
   result = num1 + num2  # 计算结果
   ```

   ```python
   # 好的示例：提供额外信息的注释
   # 将num1和num2相加得到结果
   result = num1 + num2
   ```

4. 注释的更新和维护：注释是与代码同步的重要部分，应该随着代码的修改和演进进行更新和维护。当代码发生变化时，相应的注释也需要相应地更新，以保持注释与代码的一致性。

   注释应该被视为代码的一部分，同样受到代码审查和维护的过程。确保注释的准确性和完整性，以便其他开发人员能够依赖和理解注释提供的信息。
# 五、格式化

代码的格式化对于代码的可读性和可维护性非常重要，如果你的代码没有合理的格式化，那么非常容易让你的代码看起来像一大坨💩。
通过合理地使用缩进、空格、折行和空行，我们可以使代码更易读、易于理解和维护。保持一致的格式化风格，并遵守通用的格式化准则，有助于提高代码的可读性和一致性：

1. 代码的缩进和对齐：使用一致的缩进风格来展示代码的结构和层次关系。常见的缩进方式是使用四个空格或者一个制表符（Tab）。对于每个代码块，都应该有相同的缩进级别，以便于阅读和理解代码的逻辑。

   ```python
   # 不好的示例：缩进不一致
   if condition:
   print("Condition is true!")
      print("Indented inside if block")

   # 好的示例：一致的缩进
   if condition:
       print("Condition is true!")
       print("Indented inside if block")
   ```

2. 空格的使用：在代码中适当地使用空格可以提高代码的可读性。以下是一些常见的空格使用场景：

   - 在运算符两侧和逗号后面添加空格，以增加可读性。

   ```python
   # 不好的示例：缺少空格
   result=a+b

   # 好的示例：添加空格
   result = a + b
   ```

   - 在函数的参数列表和元素列表中，逗号后面添加一个空格。

   ```python
   # 不好的示例：缺少空格
   my_function(arg1,arg2,arg3)

   # 好的示例：添加空格
   my_function(arg1, arg2, arg3)
   ```

   - 在注释中，运算符和关键字后面添加一个空格。

   ```python
   # 不好的示例：缺少空格
   #计算两个数的和
   result = num1+num2

   # 好的示例：添加空格
   # 计算两个数的和
   result = num1 + num2
   ```

3. 行的长度和折行规则：为了保持代码的可读性，应该遵守适当的行长度限制。通常，建议将每行代码限制在80个字符以内。如果一行代码超过了限制，可以使用括号、反斜杠或换行符进行折行。

   ```python
   # 不好的示例：过长的行
   long_line = "This is a very long line of code that exceeds the recommended line length and makes it hard to read and understand."

   # 好的示例：使用括号进行折行
   long_line = ("This is a very long line of code that exceeds the recommended line length "
                "and makes it hard to read and understand.")

   # 好的示例：使用反斜杠进行折行
   long_line = "This is a very long line of code that exceeds the recommended line length " \
               "and makes it hard to read and understand."

   # 好的示例：使用换行符进行折行
   long_line = "This is a very long line of code that exceeds the recommended line length\n" \
               "and makes it hard to read and understand."
   ```

4. 空行的使用：适当地使用空行可以增加代码的可读性，将代码分成逻辑块和功能块。以下是一些常见的空行使用场景：

-    在函数和类之间使用空行，以及在函数内部的逻辑块之间使用空行，以增加代码的可读性。

   ```python
   def function1():
       # 代码逻辑...

   def function2():
       # 代码逻辑...

   class MyClass:
       # 类定义...

   function1()

   function2()
   ```

   - 在函数和类的定义之前使用空行，以增加代码的可读性。

   ```python
   import module1

   import module2


   def my_function():
       # 代码逻辑...


   class MyClass:
       # 类定义...
   ```

   - 在代码的不同部分之间使用空行，以增加代码的可读性和分组。

   ```python
   import module1

   import module2


   def function1():
       # 代码逻辑...


   def function2():
       # 代码逻辑...
   ```