首页 > 其他分享 >代码整洁之道

代码整洁之道

时间:2024-01-10 11:33:25浏览次数:19  
标签:调用 函数 代码 switch 之道 xx 测试 整洁

命名
1、见名知意   变量命名应知道这个变量作用
函数
2、函数参数:标识参数:boolean;应拆分两个函数:一个函数应只做一件事
3、函数不返回null及参数不传递null
4、永不被调用的函数应该被舍弃。
别害怕删除死函数,git还会记得
5、尽可能找到并消除重复代码:重复的代码可能成为子程序或一个类。
6、if条件过多时,if(xx && xx && xx || xx) => if (xx(xxx))  将条件抽离为函数。原判断if时需要根据上下文
全局
6、switch:
    1)、尽量避免过多的switch及if/else   每个函数应该只关注自身职责;或者使用反射消除多余的if/else
    2)、将switch语句封装:如果switch是必须的,将其封装再一个函数或方法中
    3)、尽量使用多态来实现switch
7、编写代码应符合最小惊异原则:
    1)、方法和类的命名、参数的顺序和类型,以及返回值的类型应该符合用户的直观预期
    2)、系统发生错误时,错误消息应该清晰明了
    3)、如果系统有一些默认的行为,这些默认行为应该是用户最有可能期望的
8、类和对象:德墨忒耳律:避免A调用B  B调用C时,A不应该了解C的信息,比如A调用B.getC().getxxx();
9、注释C
    1)、尽可能用代码阐述注释
    2)、注释可以编写对意图的阐述
    3)、警示
    4)、todo
    5)、不能喃喃自语
    6)、多余与废话注释应移除
10、并发
    1)、限制数据作用域
    2)、使用数据副本
    3)、尽可能减少同步区域
    4)、线程尽可能独立
11、测试
    1)、别略过小测试
    2)、测试边界条件
    3)、如果某个函数发现一个缺陷时,最好全面测试那个函数。
    4)、测试应该快速

标签:调用,函数,代码,switch,之道,xx,测试,整洁
From: https://www.cnblogs.com/zsy831143/p/17956145

相关文章

  • 零代码集成自动化的实现逻辑是什么?
    零代码的概念是什么?零代码平台是一种软件开发工具或平台,非技术人员能够创建和部署应用程序,而无需编写任何代码。它提供了可视化的界面和拖拽式的操作,使用户能够通过简单的配置和组合,以图形化的方式构建应用程序。这种平台通常包含了丰富的预定义组件、模板和工具,用户可以根据自己的......
  • 使用CompletableFuture提升代码执行效率示例
    代码示例/***全国/区域数据统计:*1.新能源规模*2.电网容量*3.输配线路*4.变电站*5.工作场站**@paramareaarea*@paramuseruser*@returntheobject*@since3.0.0*/publicSt......
  • 博客趣个人静态网页模板代码
    这是一款适用于博客、新闻、公司、图片、小说、文档、商城、资源下载、网址导航等多种类型网站的博客趣网页模板。模板具有最小和清洁的设计,易于使用,并具有有趣的功能。bokequ主题简约干净的设计、在明暗风格之间进行现场切换。1、主页html代码<!doctypehtml><html><hea......
  • 代码混淆:保护您的应用程序
    引言在当今数字化时代,移动应用程序已经成为人们生活和工作中不可或缺的一部分。但是,随着应用程序数量的增加和黑客攻击手段的不断升级,应用程序的安全性也越来越受到重视。代码混淆是一种可以保护您的应用程序安全的有效手段。本文将介绍代码混淆的定义、常见手段、作用、可能带来......
  • vscode设置vue3代码格式化
    下载插件可以使用Volar或Prettier  设置格式化时选用的插件mac:【shift】+【option】+【f】win:【shift】+【alt】+【f】 选择其中之一左下角选择【设置】 点击右上角的文件切换图标,可以切换到setting.json 实际使用假设这是默认代码状态 使用Prettier默认......
  • AI与低代码解锁无限可能
    前言近年来,人工智能(AI)和低代码开发技术逐渐成为数字化转型的重要推动力。AI作为一项具有革命性潜力的技术,正在改变我们生活的方方面面。而低代码开发则提供了一种快速构建应用程序的方法,使得开发者无需深入编写大量繁琐的代码。这两种技术的结合,正为企业、开发者和用户带来前所未......
  • 【Django开发】美多商城项目第2篇:Django用户注册和登录开发(附代码,已分享)
    本系列文章md笔记(已分享)主要讨论django商城项目相关知识。项目利用Django框架开发一套前后端不分离的商城项目(4.0版本)含代码和文档。功能包括前后端不分离,方便SEO。采用Django+Jinja2模板引擎+Vue.js实现前后端逻辑,Nginx服务器(反向代理)Nginx服务器(静态首页、商品详情页、uwsgi......
  • 【机器学习】常见算法详解第2篇:K近邻算法各种距离度量(已分享,附代码)
    本系列文章md笔记(已分享)主要讨论机器学习算法相关知识。机器学习算法文章笔记以算法、案例为驱动的学习,伴随浅显易懂的数学知识,让大家掌握机器学习常见算法原理,应用Scikit-learn实现机器学习算法的应用,结合场景解决实际问题。包括K-近邻算法,线性回归,逻辑回归,决策树算法,集成学习,聚......
  • 通过印模生成电子印章-Java源代码
    以下代码是处理印模图片的核心代码,通过以下代码可以将公章图片转换为电子印章图片。制作方式分为四步:1、在白纸上加盖印章;2、把加盖印章的白纸扫描,形成图片;3、将图片通过下面的代码进行自动透明化抠图处理;4、程序返回自动透明化抠图处理后的电子印章图片。5、处理后的电子印章效果(......
  • java生成企业公章图片源代码
    企业公章图片在电子签章业务中应用广泛,在电子签章应用过程中首先需要生成公章图片,然后再使用公章图片结合数字签名技术完成电子签,这样就实现了从可视化到不可篡改的数字化电子签章功能,以下是企业公章图片生成源代码。importcom.resrun.utils.Base64;importorg.apache.pdfbox.io.......