- 综合排序
- 最热优先
- 最新优先
- 来自专栏phodal
架构守护代码化：架构文档即测试
但是呢，打开代码库，看到代码的分层实现、代码的一些规范，我们就会发现结果并非如此。 美好的开始。系统在设计的初期，架构师们都根据了自己的能力和经验，对系统进行了快速的“精心”的设计。 为什么需要架构守护代码化？ 程序员讨论写文档，也讨厌别人没写文档。 对于架构知识的记载、传播和转换，也是知识传递的范畴。 系统的架构文档持续更新，但是未能及时反应问题。 系统的架构文档持续更新，并使用了架构守护，以确保两者的一致性。 系统的架构文档即系统的架构守护测试。 PS：在早期，我也尝试为 JavaScript / TypeScript 世界，设计类似的架构守护工具（即 dilay），但前端世界对于这一类的需要并不迫切。 架构守护即代码：架构文档即测试 架构守护代码化，即使用易于阅读和维护的领域特定语言，来描述软件架构守护的规则，对诸如于分层架构、包访问规则、包数量、继承命名等进行限制。
81430发布于 2021-07-15 - 来自专栏Jenkins
Jenkins 插件文档即代码：将文档迁移到 GitHub
通过使用插件的 GitHub 仓库存储文档， 插件维护者可以遵循 文档即代码 的方法，将文档更改作为 pull request 的一部分，这样就不会忘记文档的后续工作。 几个例子： 配置即代码插件 Mailer 插件 Gradle 插件 角色策略插件 如何为你的插件启用 GitHub 文档？ 插件文档是 Hacktoberfest 活动中的一个特色项目， 我们欢迎所有对文档和代码库的贡献。 为文档做贡献 我们正在寻找有兴趣改进插件文档并帮助我们从 Wiki 迁移到 GitHub 的贡献者。 迁移文档： 迁移插件文档从 Wiki 到 GitHub 迁移文档从 Jenkins Wiki 到 jenkins.io 用于插件文档迁移的 issue 模板 [新手友好的文档任务]() 如果你有任何关于贡献文档的问题 贡献代码 您想用 Java 或 JavaScript 编写一些代码吗？或者你愿意致力于 CSS 样式并改进 Jenkins 的设计吗? 在这种情况下，欢迎向 Jenkins 插件站点做贡献。
1.2K30发布于 2019-11-26 - 来自专栏陈哥聊测试
众所周知，配置即代码≠基础设置即代码
前段时间翻到几条留言，问：“配置即代码和基础设施即代码一样吗？”“配置即代码是什么？怎么都是基础设施即代码？” 我们都是知道，DevOp的快速发展，让服务器管理与配置的时间大大减少，配置即代码和基础设施即代码作为DevOps的重要实践，在其中起到了关键性作用。 二者虽然相互补充，经常一起使用，但为了避免混淆，我将从概念、意义以及做法三个方面介绍配置即代码。一、什么是配置即代码？ 2.标准化当配置像源代码一样编写时，开发团队可以使用开发最佳实践，例如linting和安全扫描。在提交之前，必须审查并测试配置文件以保证修改符合团队的标准。配置可以通过复杂的微服务架构保持稳定和一致。 2.微服务/基于组件的开发通常情况下，开发团队会将代码分成多个存储库，再根据此架构将配置文件与特定微服务一起进行保存和版本控制。在此过程中，即便遇到与触发器构建类似的问题，但处理起来可能更简单。
39510编辑于 2024-06-24 - 来自专栏运维开发王义杰
代码即文档：一种新的软件开发哲学
代码即文档是什么？ “代码即文档”的理念源自极限编程（XP）和敏捷开发的观点，即优秀的代码应该自我说明，能够清晰地表达其意图和功能，减少额外的文档负担。 这样可以减少开发者在查找和理解代码逻辑时的时间和精力，使得开发者可以将更多的精力放在实现功能和优化代码上。 2. 因为代码本身就是最新、最准确的信息来源。 如何实践“代码即文档”？ 接下来，我们将讨论如何实践“代码即文档”的理念。以下是一些实践建议： 1. 选择有意义的命名 选择有意义的命名是实践“代码即文档”理念的第一步。无论是变量、函数还是类的命名，都应该反映其实际功能和用途。 2. 保持逻辑清晰 保持代码逻辑清晰和简洁也非常重要。 总结 “代码即文档”是一种有效的软件开发哲学，它强调代码的可读性和自我解释性，减少对独立文档的依赖。实践这种理念，可以提高开发效率，提高代码质量，确保信息的一致性。 当然，这并不是说我们不再需要文档。
1.1K10编辑于 2023-08-10 - 来自专栏记录和分享
基于抽象语法树AST和git webhook的代码即文档方案
一、导语 在日常web开发中，接口文档的撰写和维护必不可少。开发人员日常面对的挑战就是撰写接口文档的耗时及维护更新的费心费力。 本文介绍一种通过对代码的抽象语法树AST解析，来从代码本身获取接口的定义从而渲染出接口文档；再配合git的分支管理和webhook来实现随着代码的变更更新文档及按照git的分支维护历史版本的文档，并订阅文档的变化 此外基于获取到的文档元数据可为前端代码结构体自动生成、安全扫描、测试代码等提供自动对接能力。 这样开发人员只需安心写代码和维护代码中的注解注释等辅助说明信息，接口文档即会随着代码的变更更新，无需专门抽出经历撰写和维护接口文档了。 开发人员提交代码后，文档平台获取到变更的文件，通过获取代码文件的AST更新数据库中的记录，即实现了接口文档的及时更新。具体流程如下： 四、扩展 基于获取到的文档元数据，还可进行如下扩展。
1K40编辑于 2022-12-04 - 来自专栏代码小技巧分享分析
refactor，即代码重构
"refactor"，即代码重构。 造成这种状况的原因有这样一些： 1.经验不足，分析设计不到位 2.敏捷开发，虽然经验很多，但为了快速开发，没有经过分析设计 3.缺乏意识，只为实现功能而写代码，不管代码质量 对于这样的代码 这就是代码重构。重构不是针对功能，纯粹是对代码本身。重构后的代码不会影响到系统的运行。 我们来看看可以在哪些方面对代码进行重构： 1.重命名：对类，接口，方法，属性等重命名，以使得更易理解 2.抽取代码：将方法内的一段代码抽取为另一个方法，以使得该段代码可以被其他方法调用，这是重构中很重要很常用的 提升方法内的局部变量为方法的参数：这主要是在写代码的过程中会使用到 6.删除参数：将方法的一个或多个参数删掉 7.重排参数：将方法的参数顺序重新排列 实际应用中，用的最多的是1、2、3，我们可以在写代码的时候有意识的运用代码重构
1.5K00发布于 2021-10-07 - 来自专栏云云众生s
从基础设施即代码到环境即代码的进化之路
基础设施即代码(IaC)工具对于定义和自动交付云服务非常宝贵。当一个开发团队的需求扩展到此范围之外时，自动化通常就会中断。 在Git中将环境定义为代码 为了将环境定义为代码，我们首先需要以开发人员启动环境所需的一切来定义，这种格式对于DevOps来说既易于理解，又方便自动化机器读取。 下面是YAML代码片段示例: kind: environment environment_name: "Workstation Staging A" description: "EC2 workstation source: commit: "697d1" specs: instance_type: "t2.large" ami: "ami-0c55b159ertafe1f0 " security_groups: ["sg-0246e9ddc2b2f23f4"] post-deployment: scripts: [".
32610编辑于 2024-03-28 - 来自专栏Metaverse元宇宙
NFT 深度专题：代码即信任，通证即资产，数据即价值
本篇报告将对NFT进行全面梳理解析，回答7大疑问： 1)NFT的本质是什么; 2)基于什么底层技术; 3)NFT解决了什么需求; 4)2021年如此火爆背后的原因; 5)未来发展前景如何 投资建议：NFT价值传导链中分为多个角色：1)NFT项目方;2)NFT聚合平台;3)区块链平台;4)节点(矿工);5)NFT用户;6)DeFi等衍生应用。 风险提示：1)交易风险，NFT资产价格波动大，且去中心化系统仍存在被攻击后，资产被盗与丢失风险;2)政策风险，国内限制NFT二次交易，对NFT监管较为严格。 交易总规模的 NFT 系列产品 TOP10 交易量 NFT 系列占比总交易额(%) 国内 NFT 交易平台梳理 NFT 的价值传导链 该内容节选自中泰证券股份有限公司-NFT 深度专题：代码即信任 ，通证即资产，数据即价值，由分析师韩筱辰、康雅雯和朱骎楠 制作
63120编辑于 2022-03-30 - 来自专栏前端小吉米
HTTP2即未来
距今已经有xx年了, 这些年里,美国的IETF 觉得这样不行.我得出来拯救世界了, 在Chrome的倡导下, 借用Chrome的SPDY 来做为HTTP2的前身,即, HTTP2 是SPDY/3 draft 简而言之就是 H2是一个二进制协议而,H1是超文本协议.传输的内容都不是一样的 H2遵循多路复用即,代替同一host下的内容,只建立一次连接. HTTP2吸取了这次教训,决定自己开发一套优化方案,即,因为头部的更替不是很频繁,那我就在Server端做个缓存呗,在你这次连接有效的时间里面, client就用重复的发送请求头了. Server PUSH 这个机制算是 HTTP2 第二大 feature , 即, one-to-many 的机制去请求资源.因为考虑到以前,前端请求资源是通过 document 的解析来实现资源的 fetch 我直接 paste 配置代码吧: # 整体的 nginx 配置 user nginx; worker_processes auto; error_log /var/log/nginx/error.log
1.1K30发布于 2018-07-03 - 来自专栏前端开发
文档即契约：在 SAP UI5 项目中用 OpenAPI 打通代码、文档与调试全链路
开发团队若想摆脱文档滞后于代码的魔咒，就需要把文档上升到与代码同等重要的地位，让二者共生共进。 本文围绕文档即契约这一理念，结合 OpenAPI 规范与 Swagger UI，在 SAP UI5 项目中演示如何通过代码注释自动生成交互式 API 文档，并探讨版本联动与分层发布策略，帮助不同角色在同一个事实源上高效协作 文档与代码版本如何同步演进OpenAPI 文件随发布自动打 Tag 才能保证定位能力。 小结让文档成为契约，本质是把语言描述转换成可自动验证、可驱动生成的结构化资产。 只要团队把契约文件当作首要输出物，无论代码先行还是设计先行，SAP UI5 项目都能摆脱文档漂移困境，让协作真正基于同一源头的事实。
71300编辑于 2025-05-10 - 来自专栏编舟记
流水线即代码
2016年11月份的技术雷达中给出了一个简明的定义：流水线即代码 (Pipeline as Code) 通过编码而非配置持续集成/持续交付 (CI/CD) 运行工具的方式定义部署流水线。 这么做的原因很好理解，使用 CI/CD 工具是为了暴露产品代码中的问题的，如果它们自身已经复杂到不稳定的地步，我们还使用它就是自找麻烦。 从某种程度上看，实施流水线即代码是不证自明的。 说得烂俗点，流水线已经是 CI/CD 实践过程中的“最后一公里”，让流水线变成软件开发中的“一等公民”（即代码）是大势所趋、民心所向。 演进式的持续集成 如何解决 其实，流水线即代码本身已经回答这个问题了。 流水线自举 小结 流水线即代码是个新概念，也就意味着我们还需要花时间去探索与之相关的实践，比如，调试和测试（既然是代码就需要测试）。
90130发布于 2018-08-17 - 来自专栏ThoughtWorks
博客即代码 | TW洞见
而在DevOps领域有一个很火的技术实践叫做基础设施即代码。Kief对基础设施即代码的解释是这样子的： 基础设施即代码是一种使用新的技术来构建和管理动态基础设施的方式。 选取合适的语法 既然想写代码一样写博客，那么首先要选择一种语法了，这种语法就是Markdown)。 Markdown)非常容易上手，包含的tag刚刚够用，尤其展示代码非常方便，自从用了它再也不用和烦人的CSS打交道了。 选取合适的框架 实现基础设施代码需要选择一款基础设施自动化工具，这些工具的特点是全命令行操作，很容易实现自动化。 每款博客框架都有丰富的插件，这些插件的代码都放置在GitHub上，完全开源，安装配置插件也非常简单，命令行全部搞定。
1.1K80发布于 2018-04-20 - 来自专栏MongoDB中文社区
MongoDB CEO 兼总裁Dev Ittycheria: 文档即未来
在长达40年没有可替代数据库的尴尬后，我们开创了一种处理数据的全新方法——MongoDB文档模型及其相关的查询语言。 文档模型助力更快创新 文档适用于广泛的流行数据模型，支持各种各样的场景。 因此，使用文档模型显著提高了开发人员的生产效率，使组织机构能够更快地进行创新。 业界验证 近期亚马逊推出了DocumentDB，并将其描述为“支持 MongoDB 的托管文档数据库服务”。 DocumentDB 的面世毫无疑问地证明了 MongoDB 的广受欢迎程度，并强有力地验证了 MongoDB 所做的一切努力——文档即未来，而并非表格。 文档数据库不尽相同 由于数据库层是任何应用程序中最关键的一层，客户应该慎重选择数据库。
1.3K30发布于 2019-04-22 - 来自专栏用户1337634的专栏
代码自动生成文档 - Springfox(Swagger2)
Springfox的过程如下 引入Jar包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2< ="webjars/springfox-swagger-ui/**"/> Swagger配置信息 配置信息是一个Spring Bean @Configuration @EnableSwagger2 spring4.0+用 //@ConditionalOnProperty(name = "swagger.open", havingValue = "true")这个配置主要为了生产环境不生成swagger文档 ApiOperation.class)) .paths(PathSelectors.any()) .build(); } //文档信息说明和个人信息配置 WebResult.SUCCESS; } } 完成 完成以上步骤后，启动项目后可以在浏览器中打开连接http://localhost:18080/swagger-ui.html，则可以看到接口文档
1.9K20发布于 2019-03-27 PRD文档：即插即充（Plug & Charge）功能 - 慧知开源充电桩平台
以下是针对充电桩平台即插即充（Plug & Charge）功能的PRD框架，涵盖核心流程、技术实现和业务规则： PRD文档：即插即充（Plug & Charge）功能 版本号：1.0 产品经理：[你的名字 行业标杆（如特斯拉、蔚来）已支持即插即充功能，用户插枪后自动识别车辆并启动充电，大幅提升体验。 1.2 目标 简化用户操作：用户插枪即自动启动充电，无需手动操作APP。 2. 功能需求 2.1 核心流程 2.1.1 车辆身份识别 识别方式（优先级从高到低）： VIN码读取：通过充电桩通信协议（如OCPP扩展）读取车辆VIN码。 数据需求 4.1 数据埋点 关键事件： 插枪动作检测 身份识别方式（VIN/蓝牙/OCR） 识别耗时 失败原因分类（硬件故障/未绑定车辆/协议不兼容） 核心指标： 即插即充使用率（即插即充订单/总订单 附录 技术依赖清单： 充电桩硬件需支持ISO 15118协议 蓝牙模块RSSI信号强度检测能力 车牌识别API服务商选型（建议阿里云/腾讯云OCR） 接口文档： /api/charge/auto-start
15610编辑于 2026-06-17- 来自专栏CNCF
Kubernetes策略即代码是什么？
客座文章最初由 Kendall Miller 在Fairwinds 博客[1]上发表 从基础设施即代码到策略即代码 不久以前，人们开始讨论基础设施即代码（Infrastructure as Code，IaC Kubernetes 的基础架构即代码[2]可减少人为错误，增强可重复性和一致性，改善跟踪和可审计性，并有助于灾难恢复。 定义：策略即代码是通过机器可读的定义文件管理和创建策略实施工具的过程，而不是通过最佳实践文档或交互式配置工具（带有单击按钮的 GUI）。 Kubernetes 中策略作为代码的美妙之处在于，它允许你： 随时间的变化跟踪策略 包括策略执行的“为什么”信息 编写代码，使其本身成为文档的一种形式，以消除单点故障 Kubernetes 策略即代码的未来 正如基础设施即代码已经成为广泛采用的标准一样，Kubernetes 的策略即代码也在朝着同样的方向发展，因此定义基础设施的代码以及定义如何使用基础设施的代码都可以存储在一个可跟踪的仓库中。
96020发布于 2021-04-21 - 来自专栏ThoughtWorks
流水线即代码｜洞见
2016年11月份的技术雷达中给出了一个简明的定义：流水线即代码(Pipeline as Code)通过对持续集成/持续交付(CI/CD)运行工具进行编码而非配置的方式定义部署流水线。 这么做的原因很好理解，使用CI/CD工具是为了暴露产品代码中的问题，如果它们自身已经复杂到不稳定的地步，我们还使用它就是自找麻烦。 从某种程度上看，实施流水线即代码是不证自明的。 说得烂俗点，流水线已经是CI/CD实践过程中的“最后一公里”，让流水线变成软件开发中的“一等公民”（即代码）是大势所趋、民心所向。 ? 如何解决 其实，流水线即代码本身已经回答了这个问题。 小结 流水线即代码是个新概念，也就意味着我们还需要花时间去探索与之相关的实践，比如，调试和测试（既然是代码就需要测试）。
1.6K50发布于 2018-04-13 - 来自专栏Node Python Go全栈开发
Terraform: 基础设施即代码
Terraform: 基础设施即代码 问题 现如今有很多 IT 系统的基础设施直接使用了云厂商提供的服务，假设我们需要构建以下基础设施： VPC 网络 虚拟主机 负载均衡器 数据库 文件存储 ... terraform 这就是 Infrastructure as code 基础设施即代码。也就是通过代码而不是手动流程来管理和配置基础设施。 正如其官方文档所述，与手动管理基础设施相比，使用 Terraform 有以下几个优势： Terraform 可以轻松管理多个云平台上的基础设施。 使用人类可读的声明式的配置语言，有助于快速编写基础设施代码。 Terraform 的状态允许您在整个部署过程中跟踪资源更改。 可以对这些基础设施代码进行版本控制，从而安全地进行协作。 provider & module 最后 本文只是抛砖引玉罢了，有关 terraform 的更多内容还请参考官方文档及其它资料。
1.5K50编辑于 2022-03-31 - 来自专栏phodal
流程即代码：云研发、低代码 IDE —— Uncode
在先前的一系列《云研发：研发即代码》文章里，我们介绍了软件工程的代码化闭环。同时，在《Water：云研发架构模式》介绍了设计这样的开发环境里，我们所需要的一些模式。 对于云研发理论来说，我已经设计好了理论基础、软件架构、开发模式，并且对其中的一系列东西进行了验证，如：文档代码化、需求代码化、代码的代码化 等。 万物代码化 开发环境即流程。 简单来说，你可以在这个 IDE 上完成：需求的编写，转换需求为设计，设计关联代码，禅模式编程，开发完即可上线。 云研发 IDE 模式：开发环境即流程 作为一个集成开发环境，现有的 一站式 DevOps 软件研发管理协作平台 都应该只被当作管理和展示用途。 然而， 并非如此，我们还要做的事情还有一些： 开发即部署。即 local dev 便是 dev server，可直接接入现有的系统。 万物即 DSL。具备一定等级的程序语言设计能力。
83540发布于 2021-04-02 - 来自专栏AIoT技术交流、分享
文档代码同源
目录 1、问题起源 2、解决方案 2.1、需求和代码对应 2.2、每日检查 2.3、飞行检查 2.4、公共模块 3、补充说明 4、遗留问题 ---- 文档代码同源，故名思意，就是文档和代码都写在源代码文件里 这样可以：1.修改代码的时候就及时修改文档，使得文档和代码及时保持一致；2.阅读代码时，增加代码的可读性。评审代码的时候，尤其是修改时后，即对文档一同评审。 代码毕竟是非自然语言，有时候能看得懂代码，是以牺牲速度为代价的，总之，问题比较多。 2.潜台词是，文档不重要。 总之，文档、代码的问题，不仅困扰着程序员，也困扰着公司。 它的作用就是把代码里的特殊注释抽取出来变为文档(一个类似Latex的工具，非所见即所得的文档编辑工具)。我们的思路就是，利用Doxygen工具，将代码和文档的开发变为同步过程。 每日提交版本库后，由其他程序员或者部门经理检查代码及修改，检查的内容如下： 1.代码修改是否有效，符合组织内部的规定； 2.文档和代码是否对应。
80940发布于 2021-01-20
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号