[type:fix] fix code comment (#100)

Author: moremind

array/array.go

@@ -19,12 +19,16 @@ package array
 
 type any = interface{}
 
-// NotEmpty array
+// NotEmpty judge array is not empty
+//  @param arr  array
+//  @return bool not empty => true, empty => false
 func NotEmpty(arr ...any) bool {
 	return !Empty(arr)
 }
 
-// Empty array
+// Empty judge array is empty
+//  @param arr   array
+//  @return bool empty => true, not empty => false
 func Empty(arr ...any) bool {
 	return arr == nil || len(arr) == 0
 }

assert/assert.go

@@ -24,10 +24,10 @@ import (
 	"testing"
 )
 
-/*
- * Judge whether the value is nil
- * args Error prompt content
- */
+// IsNull Judge whether the value is nil
+//  @param t    test
+//  @param got  want type
+//  @param args error prompt content
 func IsNull(t *testing.T, got interface{}, args ...interface{}) {
 	fn := func() {
 		t.Errorf("!  isNull")
@@ -39,38 +39,36 @@ func IsNull(t *testing.T, got interface{}, args ...interface{}) {
 	assert(t, result, fn, 2)
 }
 
-/*
- * Judge whether the value is true
- * args Error prompt content
- */
+// IsTrue Judge whether the value is true
+//  @param t      test
+//  @param result true
+//  @param args   error prompt content
 func IsTrue(t *testing.T, result bool, args ...interface{}) {
 	tt(t, result, 1, args...)
 }
 
-/*
- * Judge whether the value is false
- * args Error prompt content
- */
+// IsFalse Judge whether the value is false
+//  @param t      test
+//  @param result false
+//  @param args   error prompt content
 func IsFalse(t *testing.T, result bool, args ...interface{}) {
 	tt(t, !result, 1, args...)
 }
 
-/*
- * Judge whether the values are not equal
- * exp Comparison value
- * got Compared value
- * args Error prompt content
- */
+// Equal Judge whether the values are not equal
+//  @param t   test
+//  @param exp expect result
+//  @param got compared value
+//  @param args error prompt content
 func Equal(t *testing.T, exp, got interface{}, args ...interface{}) {
 	equal(t, exp, got, 1, args...)
 }
 
-/*
- * Judge whether the values are equal
- * exp Comparison value
- * got Compared value
- * args Error prompt content
- */
+// NotEqual Judge whether the values are equal
+//  @param t   test
+//  @param exp expect result
+//  @param got compared value
+//  @param args error prompt content
 func NotEqual(t *testing.T, exp, got interface{}, args ...interface{}) {
 	fn := func() {
 		t.Errorf("!  Unexpected: <%#v>", exp)
@@ -82,6 +80,11 @@ func NotEqual(t *testing.T, exp, got interface{}, args ...interface{}) {
 	assert(t, result, fn, 1)
 }
 
+// assert  assertion
+//  @param t      test
+//  @param result result
+//  @param f      function
+//  @param cd	  hierarchy
 func assert(t *testing.T, result bool, f func(), cd int) {
 	if !result {
 		_, file, line, _ := runtime.Caller(cd + 1)
@@ -91,6 +94,12 @@ func assert(t *testing.T, result bool, f func(), cd int) {
 	}
 }
 
+// equal judge equal
+//  @param t   test
+//  @param exp expect result
+//  @param got compared value
+//  @param cd  hierarchy
+//  @param args error prompt content
 func equal(t *testing.T, exp, got interface{}, cd int, args ...interface{}) {
 	fn := func() {
 		t.Errorf("!  Error unlike")
@@ -102,6 +111,11 @@ func equal(t *testing.T, exp, got interface{}, cd int, args ...interface{}) {
 	assert(t, result, fn, cd+1)
 }
 
+// tt test equal
+//  @param t      test
+//  @param result wanted result
+//  @param cd     hierarchy
+//  @param args   error prompt content
 func tt(t *testing.T, result bool, cd int, args ...interface{}) {
 	fn := func() {
 		t.Errorf("!  Failure")

gox/bytesx/bytesx.go

@@ -18,18 +18,24 @@
 package bytesx
 
 // SetAll set all bytes of the slice to value
+// SetAll set all bytes of the slice to value
+//  @param b byte array
+//  @param v param
 func SetAll(b []byte, v byte) {
 	for i := 0; i < len(b); i++ {
 		b[i] = v
 	}
 }
 
 // ZeroAll set all bytes of the slice to 0
+//  @param b byte array
 func ZeroAll(b []byte) {
 	SetAll(b, 0)
 }
 
 // FromUint16LE convert uint16 to []byte in little endian
+//  @param v param
+//  @return []byte result
 func FromUint16LE(v uint16) []byte {
 	return []byte{
 		byte(v),

gox/containerx/listx/array_list.go

@@ -28,24 +28,28 @@ const defaultArraylistSize = 10
 
 // Arraylist array lst
 type Arraylist struct {
-	elements []any
+	elements []Any
 	size     int
 }
 
-// New an array list
-func New(element ...any) *Arraylist {
+// New create an array list
+//  @param element array element
+//  @return *Arraylist
+func New(element ...Any) *Arraylist {
 	lst := &Arraylist{}
-	lst.elements = make([]any, defaultArraylistSize)
+	lst.elements = make([]Any, defaultArraylistSize)
 	if len(element) > 0 {
 		lst.Add(element...)
 	}
 	return lst
 }
 
-// Add element to array list
-func (lst *Arraylist) Add(element ...any) {
+// Add save element to array list
+//  @receiver lst lst
+//  @param element array element
+func (lst *Arraylist) Add(element ...Any) {
 	if lst.size+len(element) >= len(lst.elements)-1 {
-		newElements := make([]any, lst.size+len(element)+1)
+		newElements := make([]Any, lst.size+len(element)+1)
 		copy(newElements, lst.elements)
 		lst.elements = newElements
 	}
@@ -57,7 +61,11 @@ func (lst *Arraylist) Add(element ...any) {
 }
 
 // RemoveAtIndex from array list at index
-func (lst *Arraylist) RemoveAtIndex(index int) any {
+// RemoveAtIndex remove from array list at index
+//  @receiver lst lst
+//  @param index array index
+//  @return any
+func (lst *Arraylist) RemoveAtIndex(index int) Any {
 	if index < 0 || index >= lst.size {
 		return nil
 	}
@@ -69,41 +77,63 @@ func (lst *Arraylist) RemoveAtIndex(index int) any {
 	return current
 }
 
-// Remove from array list
-func (lst *Arraylist) Remove(element any) bool {
+// Remove delete from array list
+//  @receiver lst
+//  @param element element
+//  @return bool true or false
+func (lst *Arraylist) Remove(element Any) bool {
 	return reflect.DeepEqual(lst.RemoveAtIndex(lst.IndexOf(element)), element)
 }
 
-// Get element from array list at index
-func (lst *Arraylist) Get(index int) any {
+// Get get element from array list at index
+//  @receiver lst
+//  @param index element index
+//  @return Any current result
+func (lst *Arraylist) Get(index int) Any {
 	if index < 0 || index >= lst.size {
 		return nil
 	}
 	return lst.elements[index]
 }
 
-// IndexOf element from array list
-func (lst *Arraylist) IndexOf(element any) int {
+// IndexOf index element from array list
+//  @receiver lst
+//  @param element element
+//  @return int current element index
+func (lst *Arraylist) IndexOf(element Any) int {
 	_, index := lst.find(element)
 	return index
 }
 
-// Empty array list
+// Empty judge array is empty
+//  @receiver lst
+//  @return bool true => empty, false => not empty
 func (lst *Arraylist) Empty() bool {
 	return lst == nil || lst.Size() == 0 || array.Empty(lst.elements)
 }
 
-// Size of array list
+// Size calc array length
+//  @receiver lst
+//  @return int array length
 func (lst *Arraylist) Size() int {
 	return lst.size
 }
 
-// Contains element at array list or not
-func (lst *Arraylist) Contains(element any) (bool, int) {
+// Contains judge array exist element, and return exist result and index
+//  @receiver lst
+//  @param element element
+//  @return bool   exist result
+//  @return int index
+func (lst *Arraylist) Contains(element Any) (bool, int) {
 	return lst.find(element)
 }
 
-func (lst *Arraylist) find(element any) (bool, int) {
+// find query element in array, and return exist and index
+//  @receiver lst
+//  @param element element
+//  @return bool true => exist, false => not exist
+//  @return int  current element index
+func (lst *Arraylist) find(element Any) (bool, int) {
 	for idx, current := range lst.elements {
 		if current == element {
 			return true, idx