- 综合排序
- 最热优先
- 最新优先
- 来自专栏phodal
架构守护代码化：架构文档即测试
但是呢，打开代码库，看到代码的分层实现、代码的一些规范，我们就会发现结果并非如此。 美好的开始。系统在设计的初期，架构师们都根据了自己的能力和经验，对系统进行了快速的“精心”的设计。 为什么需要架构守护代码化？ 程序员讨论写文档，也讨厌别人没写文档。 对于架构知识的记载、传播和转换，也是知识传递的范畴。 系统的架构文档持续更新，但是未能及时反应问题。 系统的架构文档持续更新，并使用了架构守护，以确保两者的一致性。 系统的架构文档即系统的架构守护测试。 PS：在早期，我也尝试为 JavaScript / TypeScript 世界，设计类似的架构守护工具（即 dilay），但前端世界对于这一类的需要并不迫切。 架构守护即代码：架构文档即测试 架构守护代码化，即使用易于阅读和维护的领域特定语言，来描述软件架构守护的规则，对诸如于分层架构、包访问规则、包数量、继承命名等进行限制。
73330发布于 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.1K30发布于 2019-11-26 - 来自专栏陈哥聊测试
众所周知，配置即代码≠基础设置即代码
前段时间翻到几条留言，问：“配置即代码和基础设施即代码一样吗？”“配置即代码是什么？怎么都是基础设施即代码？” 我们都是知道，DevOp的快速发展，让服务器管理与配置的时间大大减少，配置即代码和基础设施即代码作为DevOps的重要实践，在其中起到了关键性作用。 不少人将二者看作是一件事，配置即大代码是关于管理特定的应用程序配置设置本身，而基础设施即代码更关注的是部署支持应用程序环境所需的底层基础设施。 二者虽然相互补充，经常一起使用，但为了避免混淆，我将从概念、意义以及做法三个方面介绍配置即代码。一、什么是配置即代码？ 配置即代码（Configuration as Code，CaC） 是不同环境之间配置的版本迁移。在配置即代码的实践中，配置信息通常以文本文件的形式存储，这些文件可以用版本控制系统（如Git）进行管理。
31410编辑于 2024-06-24 - 来自专栏运维开发王义杰
代码即文档：一种新的软件开发哲学
在传统的软件开发流程中，编写文档是一个独立且重要的环节。但随着开发哲学的变化，越来越多的开发者开始接受“代码即文档”（Code as Documentation）的理念。 代码即文档是什么？ “代码即文档”的理念源自极限编程（XP）和敏捷开发的观点，即优秀的代码应该自我说明，能够清晰地表达其意图和功能，减少额外的文档负担。 因为代码本身就是最新、最准确的信息来源。 如何实践“代码即文档”？ 接下来，我们将讨论如何实践“代码即文档”的理念。以下是一些实践建议： 1. 总结 “代码即文档”是一种有效的软件开发哲学，它强调代码的可读性和自我解释性，减少对独立文档的依赖。实践这种理念，可以提高开发效率，提高代码质量，确保信息的一致性。 当然，这并不是说我们不再需要文档。 “代码即文档”的实践需要我们在日常开发中注重代码质量，注重代码的可读性和自我解释性。这可能需要一些时间和努力，但从长远看，这绝对是值得的。
1K10编辑于 2023-08-10 - 来自专栏记录和分享
基于抽象语法树AST和git webhook的代码即文档方案
一、导语 在日常web开发中，接口文档的撰写和维护必不可少。开发人员日常面对的挑战就是撰写接口文档的耗时及维护更新的费心费力。 本文介绍一种通过对代码的抽象语法树AST解析，来从代码本身获取接口的定义从而渲染出接口文档；再配合git的分支管理和webhook来实现随着代码的变更更新文档及按照git的分支维护历史版本的文档，并订阅文档的变化 此外基于获取到的文档元数据可为前端代码结构体自动生成、安全扫描、测试代码等提供自动对接能力。 这样开发人员只需安心写代码和维护代码中的注解注释等辅助说明信息，接口文档即会随着代码的变更更新，无需专门抽出经历撰写和维护接口文档了。 开发人员提交代码后，文档平台获取到变更的文件，通过获取代码文件的AST更新数据库中的记录，即实现了接口文档的及时更新。具体流程如下： 四、扩展 基于获取到的文档元数据，还可进行如下扩展。
88840编辑于 2022-12-04 - 来自专栏代码小技巧分享分析
refactor，即代码重构
"refactor"，即代码重构。 我们在看些外国人写的程序时可以发现，他们的代码里一般会定义大量的类、接口、方法，类与类，类与接口之间很多是继承和实现的关系，方法的代码行数很少，超过20行代码的方法不多，看他们的代码感觉最多的就是方法之间的调来调去 两相比较，可以看出，前者在结构上更清晰，通过类视图就可看出设计意图，并且总的代码量不会高于后者，而后者代码量庞大，代码冗余现象严重，结构不清晰，很难维护，如要修改某个错误，可能涉及到要修改的代码点很多， 这就是代码重构。重构不是针对功能，纯粹是对代码本身。重构后的代码不会影响到系统的运行。 我们来看看可以在哪些方面对代码进行重构： 1.重命名：对类，接口，方法，属性等重命名，以使得更易理解 2.抽取代码：将方法内的一段代码抽取为另一个方法，以使得该段代码可以被其他方法调用，这是重构中很重要很常用的
1.4K00发布于 2021-10-07 - 来自专栏云云众生s
从基础设施即代码到环境即代码的进化之路
基础设施即代码(IaC)工具对于定义和自动交付云服务非常宝贵。当一个开发团队的需求扩展到此范围之外时，自动化通常就会中断。 在Git中将环境定义为代码 为了将环境定义为代码，我们首先需要以开发人员启动环境所需的一切来定义，这种格式对于DevOps来说既易于理解，又方便自动化机器读取。 从那里，我们可以修改任何YAML代码，以包含环境启动时将生成的基础架构组件、参数、依赖项、元数据、身份验证和输出。 简单来说，我们利用现有的基础设施代码来定义环境为代码。 使用GitOps启动应用环境 为了满足客户的需求，我们需要使这一定义具有操作性。 我们的初始答案是依赖我们的自助门户。 随着基础设施变得越来越复杂，以代码的形式管理环境是现代DevOps组织成熟的下一步。
25810编辑于 2024-03-28 - 来自专栏Metaverse元宇宙
NFT 深度专题：代码即信任，通证即资产，数据即价值
交易总规模的 NFT 系列产品 TOP10 交易量 NFT 系列占比总交易额(%) 国内 NFT 交易平台梳理 NFT 的价值传导链 该内容节选自中泰证券股份有限公司-NFT 深度专题：代码即信任 ，通证即资产，数据即价值，由分析师韩筱辰、康雅雯和朱骎楠 制作
56820编辑于 2022-03-30 - 来自专栏前端开发
文档即契约：在 SAP UI5 项目中用 OpenAPI 打通代码、文档与调试全链路
开发团队若想摆脱文档滞后于代码的魔咒，就需要把文档上升到与代码同等重要的地位，让二者共生共进。 本文围绕文档即契约这一理念，结合 OpenAPI 规范与 Swagger UI，在 SAP UI5 项目中演示如何通过代码注释自动生成交互式 API 文档，并探讨版本联动与分层发布策略，帮助不同角色在同一个事实源上高效协作 文档与代码版本如何同步演进OpenAPI 文件随发布自动打 Tag 才能保证定位能力。 小结让文档成为契约，本质是把语言描述转换成可自动验证、可驱动生成的结构化资产。 只要团队把契约文件当作首要输出物，无论代码先行还是设计先行，SAP UI5 项目都能摆脱文档漂移困境，让协作真正基于同一源头的事实。
54200编辑于 2025-05-10 - 来自专栏编舟记
流水线即代码
2016年11月份的技术雷达中给出了一个简明的定义：流水线即代码 (Pipeline as Code) 通过编码而非配置持续集成/持续交付 (CI/CD) 运行工具的方式定义部署流水线。 这么做的原因很好理解，使用 CI/CD 工具是为了暴露产品代码中的问题的，如果它们自身已经复杂到不稳定的地步，我们还使用它就是自找麻烦。 从某种程度上看，实施流水线即代码是不证自明的。 说得烂俗点，流水线已经是 CI/CD 实践过程中的“最后一公里”，让流水线变成软件开发中的“一等公民”（即代码）是大势所趋、民心所向。 演进式的持续集成 如何解决 其实，流水线即代码本身已经回答这个问题了。 流水线自举 小结 流水线即代码是个新概念，也就意味着我们还需要花时间去探索与之相关的实践，比如，调试和测试（既然是代码就需要测试）。
81730发布于 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.2K30发布于 2019-04-22 - 来自专栏CNCF
Kubernetes策略即代码是什么？
客座文章最初由 Kendall Miller 在Fairwinds 博客[1]上发表 从基础设施即代码到策略即代码 不久以前，人们开始讨论基础设施即代码（Infrastructure as Code，IaC 定义：策略即代码是通过机器可读的定义文件管理和创建策略实施工具的过程，而不是通过最佳实践文档或交互式配置工具（带有单击按钮的 GUI）。 Kubernetes 中策略作为代码的美妙之处在于，它允许你： 随时间的变化跟踪策略 包括策略执行的“为什么”信息 编写代码，使其本身成为文档的一种形式，以消除单点故障 Kubernetes 策略即代码的未来 正如基础设施即代码已经成为广泛采用的标准一样，Kubernetes 的策略即代码也在朝着同样的方向发展，因此定义基础设施的代码以及定义如何使用基础设施的代码都可以存储在一个可跟踪的仓库中。 在 2021 年的云原生世界中，预计策略即代码将成为像 Kubernetes 在过去几年那样的热门词汇。 接下来是什么？ 对策略作为代码感兴趣？
89920发布于 2021-04-21 - 来自专栏ThoughtWorks
流水线即代码｜洞见
2016年11月份的技术雷达中给出了一个简明的定义：流水线即代码(Pipeline as Code)通过对持续集成/持续交付(CI/CD)运行工具进行编码而非配置的方式定义部署流水线。 这么做的原因很好理解，使用CI/CD工具是为了暴露产品代码中的问题，如果它们自身已经复杂到不稳定的地步，我们还使用它就是自找麻烦。 从某种程度上看，实施流水线即代码是不证自明的。 说得烂俗点，流水线已经是CI/CD实践过程中的“最后一公里”，让流水线变成软件开发中的“一等公民”（即代码）是大势所趋、民心所向。 ? 如何解决 其实，流水线即代码本身已经回答了这个问题。 小结 流水线即代码是个新概念，也就意味着我们还需要花时间去探索与之相关的实践，比如，调试和测试（既然是代码就需要测试）。
1.5K50发布于 2018-04-13 - 来自专栏Node Python Go全栈开发
Terraform: 基础设施即代码
Terraform: 基础设施即代码 问题 现如今有很多 IT 系统的基础设施直接使用了云厂商提供的服务，假设我们需要构建以下基础设施： VPC 网络 虚拟主机 负载均衡器 数据库 文件存储 ... terraform 这就是 Infrastructure as code 基础设施即代码。也就是通过代码而不是手动流程来管理和配置基础设施。 正如其官方文档所述，与手动管理基础设施相比，使用 Terraform 有以下几个优势： Terraform 可以轻松管理多个云平台上的基础设施。 使用人类可读的声明式的配置语言，有助于快速编写基础设施代码。 Terraform 的状态允许您在整个部署过程中跟踪资源更改。 可以对这些基础设施代码进行版本控制，从而安全地进行协作。 provider & module 最后 本文只是抛砖引玉罢了，有关 terraform 的更多内容还请参考官方文档及其它资料。
1.3K50编辑于 2022-03-31 - 来自专栏AIoT技术交流、分享
文档代码同源
目录 1、问题起源 2、解决方案 2.1、需求和代码对应 2.2、每日检查 2.3、飞行检查 2.4、公共模块 3、补充说明 4、遗留问题 ---- 文档代码同源，故名思意，就是文档和代码都写在源代码文件里 这样可以：1.修改代码的时候就及时修改文档，使得文档和代码及时保持一致；2.阅读代码时，增加代码的可读性。评审代码的时候，尤其是修改时后，即对文档一同评审。 它的作用就是把代码里的特殊注释抽取出来变为文档(一个类似Latex的工具，非所见即所得的文档编辑工具)。我们的思路就是，利用Doxygen工具，将代码和文档的开发变为同步过程。 即使我们不用doxygen编译，写在代码里的注释，也是不影响我们理解的。只是编译后，查阅起来更方便。 这是我们实现文档代码同源的基础。但文档代码的同源不仅仅是把代码和文档合成一个源代码文件。 无论怎么更改，只要每天保证文档、代码对应。下载最新的源代码，使用Doxygen编译，则可得到最新的文档。 3、补充说明 文档代码同源的思路，可解决实践中的文档代码不一致的问题，但这不是最终目的。
71940发布于 2021-01-20 - 来自专栏phodal
流程即代码：云研发、低代码 IDE —— Uncode
在先前的一系列《云研发：研发即代码》文章里，我们介绍了软件工程的代码化闭环。同时，在《Water：云研发架构模式》介绍了设计这样的开发环境里，我们所需要的一些模式。 对于云研发理论来说，我已经设计好了理论基础、软件架构、开发模式，并且对其中的一系列东西进行了验证，如：文档代码化、需求代码化、代码的代码化 等。 万物代码化 开发环境即流程。 简单来说，你可以在这个 IDE 上完成：需求的编写，转换需求为设计，设计关联代码，禅模式编程，开发完即可上线。 云研发 IDE 模式：开发环境即流程 作为一个集成开发环境，现有的 一站式 DevOps 软件研发管理协作平台 都应该只被当作管理和展示用途。 然而， 并非如此，我们还要做的事情还有一些： 开发即部署。即 local dev 便是 dev server，可直接接入现有的系统。 万物即 DSL。具备一定等级的程序语言设计能力。
75240发布于 2021-04-02 - 来自专栏云深之无迹
FlowShutter-硬件原理即&代码解读
接下来看下携程部分： uasyncio 是用来编写 并发 代码的库，使用 async/await 语法。 uasyncio 往往是构建 IO 密集型和高层级 结构化 网络代码的最佳选择。 Sony的串口设置，用的串口2。 具体是什么编程思想？ Sony这块就是串口和回复的状态信息，以前的版本不是携程的，如果有看不懂的，可以看历史的代码。
73910编辑于 2022-04-15 - 来自专栏云云众生s
基础设施即代码终极指南
鉴于必须保护客户数据，使用基础设施即代码构建云资源提供了一个可以由信息安全部门和基础设施团队审查和改进的蓝图。” 基础设施即代码的一个例子是什么？ “Pulumi 是您最喜欢的语言中的基础设施即代码 —— 熟悉基础设施即代码的人可能使用过其他工具，这些工具使用特定域语言甚至标记语言如 YAML 或 JSON，这在开始时通常就足够了。 这意味着您可以利用编程语言的所有丰富功能来表达您的基础设施即代码。” 基础设施即代码如何与 GitOps 集成？ 可以说，基础设施即代码就是 GitOps —— 或者至少，它是 GitOps 工作方式的一个组成部分。 Richardson 说，GitOps 和基础设施即代码包括三个不同的用例:基础设施即代码、持续集成/持续交付(特别是持续交付)和平台工程。
56210编辑于 2024-03-28 - 来自专栏生态产品
基础架构即代码入门介绍-packer
基础设施即代码的意思是把基础设施的实现方式写成代码。告别手工配置各类资源而采用基础设施即代码的方式，可以获得多种好处： 可重复-可以随时重新创建基础架构，例如在灾备环境重新创建生产环境。 可追溯回滚-环境的所有变化都通过代码实现，而代码的变化是可以追溯回滚的。 快速-由于基础架构是通过代码实现的，那么改变或者重建系统时就会非常快，是敏捷开发和DevOps中必不可少的一步。 Packer可以说是基础设施即代码的第一步。本入门介绍会帮助您了解Packer是什么，解决什么问题，有什么好处，以及怎样开始使用Packer。 关于腾讯云镜像的概述，可以参考腾讯云的文档。 Packer解决什么问题 使用预先准备好的镜像有很多好处，但是很多人都不太愿意使用这种方式，原因是创建和管理镜像实在是太复杂了。 yum install -y nginx", "systemctl enable nginx", "systemctl start nginx" ] }] } 这段代码一开始
5.6K111发布于 2019-07-29
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号