会员
众包
新闻
博问
闪存
赞助商
HarmonyOS
Chat2DB
所有博客
当前博客
我的博客
我的园子
账号设置
会员中心
简洁模式
...
退出登录
注册
登录
mharvay
博客园
首页
新随笔
联系
订阅
管理
上一页
1
2
3
4
5
6
7
···
18
下一页
2024年1月1日
优雅的书写规范化接口文档
摘要: 引文 说到接口文档,大家应该Swagger、Postman、Apifox、ApiPost等一点都不陌生。每个部门应该已经有了自己独立的一套,亦或许每个人有了自己专属的一套,不管那个,往长远考虑,好的接口文档不只是为了自己服务,也是为了将来他人服务,没了接口文档就好比没有目录的书籍,可望而不可读。 个
阅读全文
posted @ 2024-01-01 18:29 mharvay
阅读(2828)
评论(0)
推荐(0)
2023年12月31日
文档编写10要素
摘要: 1、明确文档目的 在开始编写文档之前,确保清楚了解文档的目的和受众,以便能够更好地针对他们的需求和期望进行编写。 2、计划和组织 在开始编写文档之前,进行计划和组织,列出要讨论的主题和子主题,并确定适当的文档结构。这可以帮助更好地组织思路,并确保文档具有清晰的逻辑和易于理解。 3、使用段落和标题 使
阅读全文
posted @ 2023-12-31 16:58 mharvay
阅读(167)
评论(0)
推荐(0)
2023年12月30日
代码整洁之道:整洁代码、有意义的命名
摘要: 来源:博客园(作者-BNDong) 什么是整洁代码 有多少程序员,就有多少定义。每个人理解的都不一样,我理解的整洁代码: 可读性高 尽量少的依赖关系 目的明确 没有重复的代码 高效 有意义的命名 名副其实 变量、函数或类的名称应该已经答复了所有的大问题。它该告诉你,它为什么会存在,它做什么事,应该怎
阅读全文
posted @ 2023-12-30 20:23 mharvay
阅读(54)
评论(0)
推荐(0)
上一页
1
2
3
4
5
6
7
···
18
下一页
公告