如何编写复用性、可读性和可维护性的代码

2024-02-25 17:48

本文主要是介绍如何编写复用性、可读性和可维护性的代码,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

- 平时我们在写HTML、CSS时会为类的命名耗费脑汁,本文总结了一下平时编码的心得

CSS结构化组织思想

  • 目的是讲用户界面划分为独立的块,即使使用复杂的UI,这也使界面开发变得简单快捷,并且允许重复使用现有的代码,而无需复制和粘贴。
  • CSS(块+元素+修饰符)

所谓的“块”其实就是该DOM元素共有的最基本的特性,在其命名上我们可以采取按照其目的来取名(btn或者search-form),而不是按状态(red或者big)

<div class="error"></div>

<div class="red-text"></div>

  • 该块不应影响其环境,这意味着您不应设置块的外部几何(边距)或定位。

也就是说这样可以保证其复用性比较高

元素

块的复合部分,不能与其分开使用。同理其在命名上面依赖于块的衍生(item或者text)
你可以按类似这样的取名方式(块名称__元素名称

<form class="search-form">

      <input class="search-form__input"><button class="search-form__button">Search</button>

</form>

修饰符

定义块或元素的外观,状态或行为的实体。
修饰符具有描述其外观(“多大?”或者“哪个主题?”等等- size_s或theme_islands)其状态(“它与其他人有什么不同?” - disabled,focused等),其行为(“它是否有行为?“或”它如何响应用户?“ - 例如directions_left-top)。
修饰符名称通过单个下划线(_)与块或元素名称分隔开。

<form class="search-form search-form_focused">

    <input class="search-form__input"><button class="search-form__button search-form__button_disabled">Search</button>

</form>

你可以在修饰符中添加键值来达到具体描述,从而达到可读,以便在后期维护时易于更改 (修饰符名称_键值)

<button class="search-form__button search-form__button_size_s search-form__button_size_m">

有了上述思考方式后我们可以将其应用到我们的项目文件结构中去

单个块对应于单个目录。
块和目录具有相同的名称。例如,该header块在header/目录中,该menu块在该menu/目录中。
块的实现分为单独的技术文件。例如,header.css和header.js。
块目录是其元素和修饰符的子目录的根目录。
元素目录的名称以双下划线(__)开头。例如,header/__logo/和menu/__item/。
修饰符名称的名称以单个下划线(_)开头。例如,header/_fixed/和menu/_theme_islands/。
元素和修饰符的实现分为单独的技术文件。例如,header__input.js和header_theme_islands.css。

css结构化、图片来自网络侵权删
CSS结构化参考 : BEM OOCSS SMACSS

本仅仅是提供思路,欢迎拍砖

这篇关于如何编写复用性、可读性和可维护性的代码的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/746219

相关文章

uniapp小程序中实现无缝衔接滚动效果代码示例

《uniapp小程序中实现无缝衔接滚动效果代码示例》:本文主要介绍uniapp小程序中实现无缝衔接滚动效果的相关资料,该方法可以实现滚动内容中字的不同的颜色更改,并且可以根据需要进行艺术化更改和自... 组件滚动通知只能实现简单的滚动效果,不能实现滚动内容中的字进行不同颜色的更改,下面实现一个无缝衔接的滚动

利用Python实现可回滚方案的示例代码

《利用Python实现可回滚方案的示例代码》很多项目翻车不是因为不会做,而是走错了方向却没法回头,技术选型失败的风险我们都清楚,但真正能提前规划“回滚方案”的人不多,本文从实际项目出发,教你如何用Py... 目录描述题解答案(核心思路)题解代码分析第一步:抽象缓存接口第二步:实现两个版本第三步:根据 Fea

Java计算经纬度距离的示例代码

《Java计算经纬度距离的示例代码》在Java中计算两个经纬度之间的距离,可以使用多种方法(代码示例均返回米为单位),文中整理了常用的5种方法,感兴趣的小伙伴可以了解一下... 目录1. Haversine公式(中等精度,推荐通用场景)2. 球面余弦定理(简单但精度较低)3. Vincenty公式(高精度,

QT6中绘制UI的两种方法详解与示例代码

《QT6中绘制UI的两种方法详解与示例代码》Qt6提供了两种主要的UI绘制技术:​​QML(QtMeta-ObjectLanguage)​​和​​C++Widgets​​,这两种技术各有优势,适用于不... 目录一、QML 技术详解1.1 QML 简介1.2 QML 的核心概念1.3 QML 示例:简单按钮

Java进行日期解析与格式化的实现代码

《Java进行日期解析与格式化的实现代码》使用Java搭配ApacheCommonsLang3和Natty库,可以实现灵活高效的日期解析与格式化,本文将通过相关示例为大家讲讲具体的实践操作,需要的可以... 目录一、背景二、依赖介绍1. Apache Commons Lang32. Natty三、核心实现代

使用Python自动化生成PPT并结合LLM生成内容的代码解析

《使用Python自动化生成PPT并结合LLM生成内容的代码解析》PowerPoint是常用的文档工具,但手动设计和排版耗时耗力,本文将展示如何通过Python自动化提取PPT样式并生成新PPT,同时... 目录核心代码解析1. 提取 PPT 样式到 jsON关键步骤:代码片段:2. 应用 JSON 样式到

SpringBoot实现二维码生成的详细步骤与完整代码

《SpringBoot实现二维码生成的详细步骤与完整代码》如今,二维码的应用场景非常广泛,从支付到信息分享,二维码都扮演着重要角色,SpringBoot是一个非常流行的Java基于Spring框架的微... 目录一、环境搭建二、创建 Spring Boot 项目三、引入二维码生成依赖四、编写二维码生成代码五

使用Java编写一个字符脱敏工具类

《使用Java编写一个字符脱敏工具类》这篇文章主要为大家详细介绍了如何使用Java编写一个字符脱敏工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1、字符脱敏工具类2、测试工具类3、测试结果1、字符脱敏工具类import lombok.extern.slf4j.Slf4j

使用Python和PaddleOCR实现图文识别的代码和步骤

《使用Python和PaddleOCR实现图文识别的代码和步骤》在当今数字化时代,图文识别技术的应用越来越广泛,如文档数字化、信息提取等,PaddleOCR是百度开源的一款强大的OCR工具包,它集成了... 目录一、引言二、环境准备2.1 安装 python2.2 安装 PaddlePaddle2.3 安装

SpringBoot中四种AOP实战应用场景及代码实现

《SpringBoot中四种AOP实战应用场景及代码实现》面向切面编程(AOP)是Spring框架的核心功能之一,它通过预编译和运行期动态代理实现程序功能的统一维护,在SpringBoot应用中,AO... 目录引言场景一:日志记录与性能监控业务需求实现方案使用示例扩展:MDC实现请求跟踪场景二:权限控制与