注释

必须遵守：

  • m1：优先使用英文进行注释。目前后端都是使用英文注释，前端部分是使用中文注释

  • m2：优先使用行注释 //
    尽量遵守（处女座特质）：

  • s1：在中文和英文、数字中间插入一个空格

  • s2：使用英文标点符号
  • s3：注释符号后空格再写文本，例如 // xxxx 而不是 //xxxx
  • s4：需要预格式化（<pre>）的使用 1 个空格进行缩进（参考 Go 编码规范）

示例

  1. // HTTP Handler 包装.
  2. // 完成共性处理：
  3. //  1. panic recover
  4. //  2. 请求计时
  5. func handlerWrapper(f func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request) {
  6.     handler := panicRecover(f)
  7.     handler = stopwatch(handler)
  9.     return handler
  10. }

原文: https://88250.gitbooks.io/wide-dev-guide/zh-cn/coding_conventions/comments.html