随笔分类 -  ⑤码出高效

自我修养的方式有很多,作为一个码农,最起码得修养莫过于一切始于规范
摘要:引文 说到接口文档,大家应该Swagger、Postman、Apifox、ApiPost等一点都不陌生。每个部门应该已经有了自己独立的一套,亦或许每个人有了自己专属的一套,不管那个,往长远考虑,好的接口文档不只是为了自己服务,也是为了将来他人服务,没了接口文档就好比没有目录的书籍,可望而不可读。 个 阅读全文
posted @ 2024-01-01 18:29 mharvay 阅读(1132) 评论(0) 推荐(0) 编辑
摘要:1、明确文档目的 在开始编写文档之前,确保清楚了解文档的目的和受众,以便能够更好地针对他们的需求和期望进行编写。 2、计划和组织 在开始编写文档之前,进行计划和组织,列出要讨论的主题和子主题,并确定适当的文档结构。这可以帮助更好地组织思路,并确保文档具有清晰的逻辑和易于理解。 3、使用段落和标题 使 阅读全文
posted @ 2023-12-31 16:58 mharvay 阅读(76) 评论(0) 推荐(0) 编辑
摘要:来源:博客园(作者-BNDong) 什么是整洁代码 有多少程序员,就有多少定义。每个人理解的都不一样,我理解的整洁代码: 可读性高 尽量少的依赖关系 目的明确 没有重复的代码 高效 有意义的命名 名副其实 变量、函数或类的名称应该已经答复了所有的大问题。它该告诉你,它为什么会存在,它做什么事,应该怎 阅读全文
posted @ 2023-12-30 20:23 mharvay 阅读(23) 评论(0) 推荐(0) 编辑
摘要:来源:博客园(作者-BNDong) 边界 边界上的代码需要清晰的分割和定义了期望的测试。应该避免我们的代码过多地了解第三方代码中的特定信息。依靠你能控制的东西,好过依靠你控制不了的东西,免得日后受它控制。 单元测试 TDD三定律 在编写不能通过的单元测试前,不可编写生成代码 只可编写刚好无法通过的单 阅读全文
posted @ 2023-12-29 13:37 mharvay 阅读(39) 评论(0) 推荐(0) 编辑
摘要:来源:博客园(作者-BNDong) 格式 格式目的 代码格式不可忽略,必须严肃对待。代码格式关乎沟通,而沟通是专业开发者的头等大事。(每种语言基本都有它自己的推荐标准,比如PHP的PSR代码规范,对格式做了详细的定义) 垂直格式 单文件。书中的建议是,单文件的代码量不易过大。短文件通常比长文件易于理 阅读全文
posted @ 2023-12-28 09:29 mharvay 阅读(27) 评论(0) 推荐(0) 编辑
摘要:来源:博客园(作者-BNDong) 函数 短小 函数的第一规则是要短小。第二条规则是还要更短小。 if语句、else语句、while语句等,其中代码块应该只有一行。该行大抵应该是一个函数调用语句。这样不但能保持函数短小,而且,因为块内调用的函数拥有较具说明性的名称,从而增加了文档上的价值。(虽然在实 阅读全文
posted @ 2023-12-26 10:19 mharvay 阅读(45) 评论(0) 推荐(0) 编辑

点击右上角即可分享
微信分享提示