golint most of the code

tars/application.go

@@ -24,6 +24,8 @@ var httpSvrs map[string]*http.Server
 var shutdown chan bool
 var serList []string
 var objRunList []string
+
+//TLOG is the logger for tars framework.
 var TLOG = rogger.GetLogger("TLOG")
 var initOnce sync.Once
 
@@ -37,20 +39,16 @@ func init() {
 	httpSvrs = make(map[string]*http.Server)
 	shutdown = make(chan bool, 1)
 	adminMethods = make(map[string]adminFn)
-	//在配置初始化前将日志关闭，减少独立客户端日志
 	rogger.SetLevel(rogger.ERROR)
 	Init()
 }
 
-//有些场景下需要提前初始化时调用:
-//比如Imp里调用了通信器、
-//AddServant时使用了全局配置等等。
+//Init should run before GetServerConfig & GetClientConfig , or before run
+// and Init should be only run once
 func Init() {
 	initOnce.Do(initConfig)
 }
 
-//服务的初始化函数,默认会在Run的时候启动
-//
 func initConfig() {
 	confPath := flag.String("config", "", "init config path")
 	flag.Parse()
@@ -158,6 +156,7 @@ func initConfig() {
 	go initProReport()
 }
 
+//Run the application
 func Run() {
 	Init()
 	<-statInited

tars/httpserver.go

@@ -2,10 +2,11 @@ package tars
 
 import (
 	"fmt"
-	"github.com/TarsCloud/TarsGo/tars/protocol/res/statf"
 	"net/http"
 	"strings"
 	"time"
+
+	"github.com/TarsCloud/TarsGo/tars/protocol/res/statf"
 )
 
 var realIPHeader []string
@@ -14,10 +15,11 @@ func init() {
 	realIPHeader = []string{ // the order is important
 		"X-Real-Ip",
 		"X-Forwarded-For-Pound",
-		"X-Forwarded-For", //是一个列表，暂时全报吧
+		"X-Forwarded-For",
 	}
 }
 
+//TarsHttpConf is configuration for tars http server.
 type TarsHttpConf struct {
 	Container string
 	AppName   string
@@ -27,6 +29,7 @@ type TarsHttpConf struct {
 	SetId     string
 }
 
+//TarsHttpMux is http.ServeMux for tars http server.
 type TarsHttpMux struct {
 	http.ServeMux
 	cfg *TarsHttpConf
@@ -39,6 +42,7 @@ type httpStatInfo struct {
 	costTime   int64
 }
 
+//ServeHTTP is the server for the TarsHttpMux.
 func (mux *TarsHttpMux) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	if r.RequestURI == "*" {
 		if r.ProtoAtLeast(1, 1) {
@@ -114,15 +118,18 @@ func (mux *TarsHttpMux) reportHttpStat(st *httpStatInfo) {
 	StatReport.pushBackMsg(info, true)
 }
 
+//SetConfig sets the cfg tho the TarsHttpMux.
 func (mux *TarsHttpMux) SetConfig(cfg *TarsHttpConf) {
 	mux.cfg = cfg
 }
 
+//TarsResponseWriter is http.ResponseWriter for tars.
 type TarsResponseWriter struct {
 	http.ResponseWriter
 	statusCode int
 }
 
+//WriteHeader is used for write the http header with the http code.
 func (w *TarsResponseWriter) WriteHeader(code int) {
 	w.statusCode = code
 	w.ResponseWriter.WriteHeader(code)

tars/logger.go

@@ -1,8 +1,9 @@
 package tars
 
 import (
-	"github.com/TarsCloud/TarsGo/tars/util/rogger"
 	"path/filepath"
+
+	"github.com/TarsCloud/TarsGo/tars/util/rogger"
 )
 
 // GetLogger Get a logger
@@ -42,14 +43,15 @@ func GetHourLogger(name string, numHour int) *rogger.Logger {
 	return lg
 }
 
+//GetRemoteLogger returns a remote logger
 func GetRemoteLogger(name string) *rogger.Logger {
 	cfg := GetServerConfig()
 	lg := rogger.GetLogger(name)
 	if !lg.IsConsoleWriter() {
 		return lg
 	}
 	remoteWriter := NewRemoteTimeWriter()
-	var set string = ""
+	var set string
 	if cfg.Enableset {
 		set = cfg.Setdivision
 	}

tars/model/Servant.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/TarsCloud/TarsGo/tars/protocol/res/requestf"
 )
-
+//Servant is interface for call the remote server.
 type Servant interface {
 	Tars_invoke(ctx context.Context, ctype byte,
 		sFuncName string,

tars/nodef.go

@@ -1,16 +1,19 @@
 package tars
 
 import (
-	"github.com/TarsCloud/TarsGo/tars/protocol/res/nodef"
 	"os"
+
+	"github.com/TarsCloud/TarsGo/tars/protocol/res/nodef"
 )
 
+//NodeFHelper is helper struct.
 type NodeFHelper struct {
 	comm *Communicator
 	si   nodef.ServerInfo
 	sf   *nodef.ServerF
 }
 
+//SetNodeInfo sets the node location for the given Communicator.
 func (n *NodeFHelper) SetNodeInfo(comm *Communicator, node string, app string, server string) {
 	n.comm = comm
 	n.sf = new(nodef.ServerF)
@@ -25,6 +28,7 @@ func (n *NodeFHelper) SetNodeInfo(comm *Communicator, node string, app string, s
 	}
 }
 
+//KeepAlive sends the keepalive pacakage to the node.
 func (n *NodeFHelper) KeepAlive(adapter string) {
 	n.si.Adapter = adapter
 	_, err := n.sf.KeepAlive(&n.si)
@@ -33,6 +37,7 @@ func (n *NodeFHelper) KeepAlive(adapter string) {
 	}
 }
 
+//ReportVersion report the tars version to the node.
 func (n *NodeFHelper) ReportVersion(version string) {
 	_, err := n.sf.ReportVersion(n.si.Application, n.si.ServerName, version)
 	if err != nil {

tars/notifyf.go

@@ -2,12 +2,14 @@ package tars
 
 import "github.com/TarsCloud/TarsGo/tars/protocol/res/notifyf"
 
+//NotifyHelper is the helper struct for the Notify service.
 type NotifyHelper struct {
 	comm *Communicator
 	tn   *notifyf.Notify
 	tm   notifyf.ReportInfo
 }
 
+//SetNotifyInfo sets the notify server location for the Communicator.
 func (n *NotifyHelper) SetNotifyInfo(comm *Communicator, notify string, app string, server string, container string) {
 	n.comm = comm
 	n.comm.SetProperty("netthread", 1)
@@ -30,6 +32,7 @@ func (n *NotifyHelper) SetNotifyInfo(comm *Communicator, notify string, app stri
 	}
 }
 
+//ReportNotifyInfo report the info to the notify server.
 func (n *NotifyHelper) ReportNotifyInfo(info string) {
 	n.tm.SMessage = info
 	TLOG.Debug(n.tm)