×
思维导图备注
Go 语言实战: 编写可维护 Go 语言代码建议
首页
小程序
下载
阅读记录
书签管理
我的书签
添加书签
移除书签
编辑文档
6. API 设计
来源 1
浏览
1261
扫码
分享
2019-07-22 19:27:48
6. API 设计
上一篇:
下一篇:
介绍
1. 指导原则
1.1. 简单性
1.2. 可读性
1.3. 生产力
编者的话
2. 标识符
2.1. 选择标识符是为了清晰，而不是简洁
2.2. 标识符长度
2.2.1. 上下文是关键
2.3. 不要用变量类型命名你的变量
2.4. 使用一致的命名方式
2.5. 使用一致的声明样式
2.6. 成为团队合作者
3. 注释
3.1. 关于变量和常量的注释应描述其内容而非其目的
3.2. 公共符号始终要注释
3.2.1. 不要注释不好的代码，将它重写
3.2.2. 与其注释一段代码，不如重构它
4. 包的设计
4.1. 一个好的包从它的名字开始
4.2. 避免使用类似 base，common 或 util 的包名称
4.3. 尽早 return 而不是深度嵌套
4.4. 让零值更有用
4.5. 避免包级别状态
5. 项目结构
5.1. 考虑更少，更大的包
5.1.1. 通过 import 语句将代码排列到文件中
5.1.2. 优先内部测试再到外部测试
5.1.3. 使用 internal 包来减少公共API
5.2. 确保 main 包内容尽可能的少
6. API 设计
6.1. 设计难以被误用的 API
6.2. 为其默认用例设计 API
6.2.1. 不鼓励使用 nil 作为参数
6.2.2. 首选可变参数函数而非 []T 参数
6.3. 让函数定义它们所需的行为
7. 错误处理
7.1. 通过消除错误来消除错误处理
7.1.1. 计算行数
7.1.2. WriteResponse
7.2. 错误只处理一次
7.2.1. 为错误添加相关内容
7.2.2. 使用 github.com/pkg/errors 包装 errors
8. 并发
8.1. 保持自己忙碌或做自己的工作
8.2. 将并发性留给调用者
8.3. 永远不要启动一个停止不了的 goroutine。
暂无相关搜索结果！
本文档使用
BookStack
构建
×
分享，让知识传承更久远
×
文章二维码
手机扫一扫，轻松掌上读
×
文档下载
请下载您需要的格式的文档，随时随地，享受汲取知识的乐趣！
PDF
文档
EPUB
文档
MOBI
文档
×
微信小程序阅读
微信扫一扫，知识掌上学
×
书签列表
×
阅读记录
阅读进度:
0.00%
(
0/0
)
重置阅读进度
我的书签
添加书签
移除书签