markdown 记录代码API的排版建议
函数 - 多形参 - 形参选项(函数)
保证标题都是函数API,便于定位,无繁琐归类冗余,形参归类引用放到函数参数说明
# 函数
函数说明
- 形参
- 选项:选项说明
- 选项:选项说明
- 形参
- 选项
- 选项
## 选项函数
# 函数
函数说明
- 形参
- 选项:选项说明
- 选项:选项说明
- 形参
- 选项
- 选项
## 选项函数
函数说明
- 形参
- 选项:选项说明
- 选项:选项说明
- 形参
- 选项
- 选项
函数
└── 选项函数
以下就过于冗余,API不好直观定位
# 函数
## 形参
### 选项函数
#### 选项函数形参
## 形参
### 选项
函数
└── 参数
└── 选项函数
└── 参数
示例
grpc.Dial
创建一个到 gRPC 服务端的连接。
func Dial(target string, opts ...DialOption) (*ClientConn, error)
target:gRPC 服务地址opts:连接配置项(DialOption)grpc.WithTransportCredentials:配置 TLS / 传输层认证grpc.WithBlock:阻塞直到连接建立grpc.WithTimeout:设置连接超时
grpc.WithTransportCredentials
配置连接的传输层认证方式。
func WithTransportCredentials(
creds credentials.TransportCredentials,
) DialOption
creds:传输层认证配置insecure.NewCredentials:关闭 TLS,使用明文 HTTP/2
insecure.NewCredentials
关闭 TLS,加密被禁用,使用明文 HTTP/2 通信。
insecure.NewCredentials()

浙公网安备 33010602011771号