update doc

Author: lixizan

README.md

@@ -15,7 +15,7 @@ import (
 func main() {
 	mc := memorycache.New(
 		memorycache.WithSegment(16),
-		memorycache.WithTTLCheckInterval(100*time.Millisecond),
+		memorycache.WithTTLCheckInterval(30*time.Second),
 	)
 	mc.Set("xxx", 1, 500*time.Millisecond)
 	time.Sleep(time.Second)

config.go

@@ -9,19 +9,28 @@ const (
 
 type (
 	Config struct {
-		TTLCheckInterval time.Duration // 过期检查周期
-		Segment          uint32        // 分片数, segment=2^n, eg: 4, 8, 16...
+		// 过期时间检查周期
+		// expiration time inspection cycle
+		TTLCheckInterval time.Duration //
+
+		// 分片数, segment=2^n, eg: 4, 8, 16...
+		// number of hashmap pieces, eg: 4, 8, 16...
+		Segment uint32
 	}
 
 	Option func(c *Config)
 )
 
+// WithSegment
+// Set Segment
 func WithSegment(segment uint32) Option {
 	return func(c *Config) {
 		c.Segment = segment
 	}
 }
 
+// WithTTLCheckInterval
+// Set TTLCheckInterval
 func WithTTLCheckInterval(TTLCheckInterval time.Duration) Option {
 	return func(c *Config) {
 		c.TTLCheckInterval = TTLCheckInterval

index.go

@@ -34,8 +34,11 @@ func (c *MemoryCache) getExpireTimestamp(expiration time.Duration) int64 {
 	return time.Now().Add(expiration).UnixNano() / 1000000
 }
 
+// Set
 // 设置键值和过期时间
 // expiration: <=0表示永不过期
+// set the key value and expiration time
+// expiration: <=0 means never expire
 func (c *MemoryCache) Set(key string, value interface{}, expiration time.Duration) {
 	var ele = types.Element{
 		Value:    value,
@@ -54,7 +57,9 @@ func (c *MemoryCache) Set(key string, value interface{}, expiration time.Duratio
 	bucket.Unlock()
 }
 
+// Get
 // 根据键获取值
+// get value by key
 func (c *MemoryCache) Get(key string) (interface{}, bool) {
 	var bucket = c.storage.GetBucket(key)
 	bucket.RLock()
@@ -66,7 +71,9 @@ func (c *MemoryCache) Get(key string) (interface{}, bool) {
 	return result.Value, true
 }
 
+// Delete
 // 删除一个键
+// delete value by key
 func (c *MemoryCache) Delete(key string) {
 	var bucket = c.storage.GetBucket(key)
 	bucket.Lock()
@@ -91,7 +98,9 @@ func (c *MemoryCache) Expire(key string, expiration time.Duration) {
 	bucket.Unlock()
 }
 
-// 获取所有键
+// Keys
+// 获取所有有效的键
+// list valid keys
 func (c *MemoryCache) Keys() []string {
 	var arr = make([]string, 0)
 	var now = utils.Timestamp()
@@ -107,7 +116,9 @@ func (c *MemoryCache) Keys() []string {
 	return arr
 }
 
+// Len
 // 获取有效元素个数
+// get the number of valid keys
 func (c *MemoryCache) Len() int {
 	var num = 0
 	var now = utils.Timestamp()

index_test.go

@@ -10,7 +10,7 @@ func TestNew(t *testing.T) {
 	var as = assert.New(t)
 
 	t.Run("", func(t *testing.T) {
-		var db = New(WithTTLCheckInterval(100 * time.Millisecond))
+		var db = New()
 		db.Set("a", 1, time.Second)
 		db.Set("b", 1, 3*time.Second)
 		db.Set("c", 1, 5*time.Second)
@@ -23,7 +23,7 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("", func(t *testing.T) {
-		var db = New(WithTTLCheckInterval(100 * time.Millisecond))
+		var db = New()
 		db.Set("a", 1, time.Second)
 		db.Set("b", 1, 2*time.Second)
 		db.Set("c", 1, 5*time.Second)
@@ -36,7 +36,7 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("", func(t *testing.T) {
-		var db = New(WithTTLCheckInterval(100 * time.Millisecond))
+		var db = New()
 		db.Set("a", 1, time.Second)
 		db.Set("b", 1, 2*time.Second)
 		db.Set("c", 1, 4*time.Second)