3.注释
不要对差的代码增加注释，而是要去重构它。
代码是最新的，而注释未必是最新的。所以会误导读者，从而使整个系统一片混乱
原则
1. 选择写干净的代码，而不是为差的代码添加注释。这样会越来越糟
2. 用代码来描述你的想法，而不是注释。选择好的命名和组织合理的方法
3. 最好的注释就是没有注释。先保证在没比写注释更好的方法时才选择用注释来补充说明，同时更要注意保证注释的正确性
4. 好的注释能表达更深层次的思想，有利于代码的理解。
5. 注释能提供一些警示或强调信息，//TODO,//FIXME等便于查找关键点
6. 如果注释是多余的，形而上学的，选择毫不犹豫的去掉它。
7. 不用写日记式的代码跟踪记录，因为这会让你的代码臃肿。同时借助版本控制，可以很好的完成代码管理的重任
8. 注释应该写在合适的位置，注释合适的对象。如果距离过大就会给人造成困扰。同时注释内容也不宜过多。
实践
1. 尽量写好代码，花些实践在命名和方法上，而不是给差代码写注释
2. 如果必要写一些关键的说明文字，方便读者理解，特别是一些思维的跳跃点。
3. 确保注释和代码的同步
4.格式化
原则
1. 格式化的目的是为了可读性，组织得当，条理清晰。
2. 类不宜太长，最好不要超过500行
3. 方法的顺序和调用的顺序相关，可以符合逻辑的阅读
4. 紧密关联的东西不要隔开，而隔开那些不是紧密关联的代码
5. 变量的申明应靠近它使用的地方
6. 实例变量应定义在类名的开头
7. 每行的代码的长度不要超过120即可
8. 用好缩进，特别是嵌套语句，很能提高可读性
9. 每个团队应该有个一致的规则
10. 平时多用用格式化工具 ctrl+shilf+f
实践
1. 平时多注意代码质量，用好工具，多用工具
2. 设立一个符合团队的标准
分享到：
相关推荐
Java 员工管理系统项目是一个基于 Java 编程语言开发的桌面应用程序，旨在管理员工的信息、津贴、扣除和薪资等功能。该系统通过提供结构和工具集，使公司能够有效地管理其员工数据和薪资流程。 系统特点 员工管理：管理员可以添加、查看和更新员工信息。 津贴管理：管理员可以添加和管理员工的津贴信息。 扣除管理：管理员可以添加和管理员工的扣除信息。 搜索功能：可以通过员工 ID 搜索员工详细信息。 更新薪资：管理员可以更新员工的薪资信息。 支付管理：处理员工的支付和生成支付记录。 模块介绍 员工管理模块：管理员可以添加、查看和更新员工信息，包括员工 ID、名字、姓氏、年龄、职位和薪资等。 津贴管理模块：管理员可以添加和管理员工的津贴信息，如医疗津贴、奖金和其他津贴。 扣除管理模块：管理员可以添加和管理员工的扣除信息，如税收和其他扣除。 搜索功能模块：可以通过员工 ID 搜索员工详细信息。 更新薪资模块：管理员可以更新员工的薪资信息。 支付管理模块：处理员工的支付和生成支付记录 可以作为毕业设计项目参考
CAD实验报告：制药车间动力控制系统图、烘烤车间电气控制图、JSJ型晶体管式时间继电器原理图、液位控制器电路图
项目简介： 本项目将教您如何使用 Arduino 和 Python 实时数据绘图来构建温度监控系统。通过这个项目，您将学习如何从 Arduino 到 Python 进行串行通信，并实时收集和监控温度数据。 项目目标： 实时监控和绘制温度数据。 提供用户友好的操作界面。 提高用户的编程技能，特别是Arduino和Python的应用能力。 项目功能 实时温度监控： 传感器每秒读取一次温度数据，并通过串行监视器发送到Python程序。 数据保存： Python程序将温度数据保存到CSV文件中。 实时数据绘图： 使用Matplotlib库实时绘制温度数据，温度在Y轴，时间在X轴。 项目优势 高效的数据监控： 实时监控和绘制温度数据，提高数据监控的效率。 用户友好： 界面简洁，操作简单，用户可以轻松使用该应用程序。 提高编程技能： 通过实践项目，提高对Arduino和Python的应用能力。 项目技术细节 项目详情： 项目名：使用 Arduino 和 Python 实时数据绘图的温度监控系统 项目平台：Arduino 和 Python 使用的编程语言：C++（Arduino）、Python ID
本测试计划提供给深圳移动公司PMS核心小组成员，对PMS EXPRESS 系统进行功能测试。测试计划主要通过对基站项目管理过程的模拟，从项目的立项开始直至基站的验收交付以及知识沉淀，对基站建设全过程中涉及的管理内容进行模拟测 试。测试计划中设计了两个基站项目一明宁花园、椰风海岸。其中明宁花园按 原计划如期完工，而椰风海岸因为设备没能如期到货导致了个整个项目工期的延误。
博物馆智能化系统的解决方案.pptx
基于STM32的电子罗盘试验
【matlab GUI仿真】说明：GUI界面设计，四旋翼飞机仿真。VR界面设计。 (GUI interface design, four rotor aircraft simulation. The VR interface design. ) 【matlab GUI仿真】说明：GUI界面设计，四旋翼飞机仿真。VR界面设计。
项目简介： 本项目实现了一个基于VHDL（VHSIC硬件描述语言）的倒车雷达系统。倒车雷达用于检测车辆后方障碍物的距离，以辅助驾驶员安全倒车。系统通过超声波传感器检测距离，并使用LED显示或蜂鸣器提示障碍物的接近程度。 项目模块： 传感器接口模块： 处理超声波传感器的信号。 发送触发信号，接收回波信号。 计算回波时间，进而计算距离。 距离计算模块： 根据传感器回波时间计算距离。 处理和转换距离数据，准备用于显示和警报。 警报显示模块： 基于计算出的距离提供视觉和听觉警报。 使用LED显示不同的距离范围。 使用蜂鸣器发出不同频率的警报声。 控制模块： 控制各模块的协调工作。 管理超声波传感器的触发和数据采集周期。
行业报告
毕业设计ssm框架在线课堂微信小程序源码+项目说明（高分毕设）.zip 个人经导师指导并认可通过的高分设计项目，评审分98分。主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者，也可作为课程设计、期末大作业。 毕业设计ssm框架在线课堂微信小程序源码+项目说明（高分毕设）.zip 个人经导师指导并认可通过的高分设计项目，评审分98分。主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者，也可作为课程设计、期末大作业。 毕业设计ssm框架在线课堂微信小程序源码+项目说明（高分毕设）.zip 个人经导师指导并认可通过的高分设计项目，评审分98分。主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者，也可作为课程设计、期末大作业。 项目主要功能： 该项目是一款针对在线课堂微信小程序的数据管理系统，旨在便捷用户对小程序中的信息进行有效管理。系统设计注重功能完善和用户体验，力求使用户能轻松找到所需信息。采用JAVA技术开发，并结合现有成熟源代码模板，确保了平台的可操作性和实用性。关键词：在线课堂微信小程序；JAVA。
国内锂矿加速开发，四川锂矿详细梳理
一个基于react框架的资源文件 练习，xiaoyoushop分支是小优后台，screen分支是大屏项目，react分支是基于react框架，使用ts语言，vite构建的一个后台管理系统项目 练习，xiaoyoushop分支是小优后台，screen分支是大屏项目，react分支是基于react框架，使用ts语言，vite构建的一个后台管理系统项目 练习，xiaoyoushop分支是小优后台，screen分支是大屏项目，react分支是基于react框架，使用ts语言，vite构建的一个后台管理系统项目 内容来源于网络分享。仅供学习使用。请勿商用。如有侵权，请联系我。我将立即删除
MQD企业大学建设思路与年度工作重点.pptx
Java语言基础入门教程 Java实训教程 13.反射 共38页.pptx
网上购物商城数据库设计报告.docx
单机成本核算统计表.docx
Swift 是由苹果公司推出的一种现代化的编程语言，用于开发 iOS、macOS、watchOS 和 tvOS 应用程序。它结合了安全、高性能和易用性的特点，成为开发苹果平台应用程序的首选语言。
创建一个简单的PHP页面
乐视生态链生态系统介绍.pptx
当安装TensorFlow时，我们需要按照一系列步骤来确保正确无误。以下是一个详细的TensorFlow安装教程，包括准备工作、安装步骤以及验证安装等部分。 准备工作 1. 检查系统要求 确保你的系统满足TensorFlow的硬件和软件要求。TensorFlow支持Python 3.5-3.8版本，并需要一个64位操作系统。对于GPU加速，需要支持CUDA的NVIDIA GPU。 2. 安装Python 从Python官方网站或可靠的国内镜像源下载并安装适合你操作系统的Python版本（建议Python 3.7或3.8）。 3. 安装pip pip是Python的包管理器，用于安装和管理Python包。在安装Python时，通常会同时安装pip。如果没有安装，请从pip官方网站下载并安装。 安装TensorFlow 1. 升级pip 打开命令行工具（在Windows上是CMD或PowerShell，在macOS和Linux上是Terminal）。 运行以下命令来升级pip到最新版本： bash复制代码 pip install --upgrade pip 2. 使用pip安装