Golang 代码注释规范

1. 注释规范

1. go 文件

   规范：

   // @Title	（文件名）
   // @Description	（描述）
   // @Author	（作者）
   // @Update	（修改者）
   

   示例：

   // @Title	integrationConcurrent.go
   // @Description	基于fork-jion-pi模式的Golang实现蒙特卡洛积分的并行计算-实现方法
   // @Author	ZhangAoNan
   // @Update	ZhangAoNan
   

2. 函数

   规范:

   // @title	（函数名）
   // @descroption	 （函数功能描述）
   // @auth	（作者）	（日期）
   // @update	（修改者）	（日期）
   // @param	（变量名）	（类型）	（"描述"）
   // @return	(返回参数名) （"描述"）
   

   示例：

   // @title	MonteCarloIntegrationConcurrent
   // @descroption	 基于fork-jion模式的Golang实现蒙特卡洛积分的并行计算
   // @auth	张奥男	（2022/09/27）
   // @param	n	int		"任务总数"
   // @param 	X[] float64	"自变量数组"
   // @param	ig Integration	"积分对象"
   // @param	a, b float64 	"积分区间"
   // @param 	 numGoroutine	int		"轻量级线程数"
   // @return 	out	float64 "积分结果" 
   

3. 接口 结构体

   规范：

   // 结构体名称	描述  
   type Integration interface {
   	Func(x float64) float64
   }
   

   示例：

   // Integration	积分接口  定义了 Func 函数
   type Integration interface {
   	Func(x float64) float64
   }