代码注释

editor/formatter.go

@@ -11,6 +11,8 @@ import (
 	"github.com/golang/glog"
 )
 
+// TODO: 加入 goimports 格式化 Go 源码文件
+
 // gofmt 格式化 Go 源码文件.
 func GoFmtHandler(w http.ResponseWriter, r *http.Request) {
 	data := map[string]interface{}{"succ": true}
@@ -73,6 +75,7 @@ func GoFmtHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 // 格式化 HTML 文件.
+// FIXME：依赖的工具 gohtml 格式化 HTML 时有问题
 func HTMLFmtHandler(w http.ResponseWriter, r *http.Request) {
 	data := map[string]interface{}{"succ": true}
 	defer util.RetJSON(w, r, data)

event/events.go

@@ -31,6 +31,7 @@ type UserEventQueue struct {
 	Handlers []Handler // 事件处理器集
 }
 
+// 事件队列集类型.
 type Queues map[string]*UserEventQueue
 
 // 用户事件队列集.

output/processes.go

@@ -8,11 +8,12 @@ import (
 	"github.com/golang/glog"
 )
 
+// 进程集类型.
+type procs map[string][]*os.Process
+
 // 所有用户正在运行的程序进程集.
 //
 // <sid, []*os.Process>
-type procs map[string][]*os.Process
-
 var processes = procs{}
 
 // 排它锁，防止并发修改.

session/sessions.go

@@ -57,6 +57,7 @@ type WideSession struct {
 	Updated     time.Time                  // 最近一次使用时间
 }
 
+// 会话集类型.
 type Sessions []*WideSession
 
 // 所有 Wide 会话集.
@@ -67,7 +68,7 @@ var mutex sync.Mutex
 
 // 在一些特殊情况（例如浏览器不间断刷新/在源代码视图刷新）下 Wide 会话集内会出现无效会话，该函数定时（1 小时）检查并移除这些无效会话.
 //
-// 无效会话：在检查时间内 30 分钟都没有使用过的会话，WideSession.Updated 字段.
+// 无效会话：在检查时间内 30 分钟都没有使用过的会话，参考 WideSession.Updated 字段.
 func FixedTimeRelease() {
 	go func() {
 		for {

session/users.go

@@ -1,6 +1,6 @@
 package session
 
-// TODO: 这个包目前没有使用，只是开了个头 :p
+// TODO: 这个文件内的功能目前没有使用，只是开了个头 :p
 
 import (
 	"encoding/json"