添加对option的说明

andrewgithub · andrewgithub · commit 0b35c12fc6e8 · 2023-08-29T15:08:18.000+08:00
diff --git a/doc/instruction/readme.adoc b/doc/instruction/readme.adoc
@@ -59,7 +59,7 @@ endif::rootpath[]
 
 使用 `static Status Open(const Options &options, const std::string &name, DB **dbptr)` 可以打开一个数据库， options填入数据库打开选项，name指定数据库名，DB给出一个数据库指针(原先指向nullptr)，因为调用之后会把创建的数据库句柄赋值给对应的指针。
 
-- Options 用来控制数据库行为的一些参数在调用 `DB::Open` 的时候使用。
+- Options 用来控制数据库行为的一些参数在调用 `DB::Open` 的时候使用，下面试Options的说明
 
 [source,c++]
 ----
diff --git a/doc/persistence/log_format.adoc b/doc/persistence/log_format.adoc
@@ -78,7 +78,7 @@ bytes free in the third block, which will be left empty as the trailer.
 
 **C** will be stored as a FULL record in the fourth block.
 
-----
+
 
 ## Some benefits over the recordio format:
 
diff --git a/doc/utils/c++_common_knowledge.adoc b/doc/utils/c++_common_knowledge.adoc
@@ -109,7 +109,7 @@ class NoDestructor {
 
 *总结*
 
-这一个实例的创建使用了三个比较重要的C++知识点，alignof取结构体对齐长度，`new（placement new）` 来实现预分配内存的new，在结合 `aligned_storage` 来保证已有对象内存绝对大于等于需要申请对象的内存，然后经过饿汉式单例模式封装，经过以上几个步骤之后，一个能长久陪伴数据库句柄的对比工具便诞生了。
+在整个levelDB中有很多地方都用了这个特性进行单例的创建，在这个实例的创建中使用了三个比较重要的C++知识点，alignof取结构体对齐长度，`new（placement new）` 来实现预分配内存的new，在结合 `aligned_storage` 来保证已有对象内存绝对大于等于需要申请对象的内存，然后经过饿汉式单例模式封装，经过以上几个步骤之后，一个能长久陪伴数据库句柄的对比工具便诞生了。
 
 
 
diff --git a/include/leveldb/options.h b/include/leveldb/options.h
@@ -34,33 +34,25 @@ namespace leveldb {
         kSnappyCompression = 0x1
     };
 
-// Options to control the behavior of a database (passed to DB::Open)
+// Options 通过传入给 DB::OPen 来控制数据库行为
     struct LEVELDB_EXPORT Options {
-        // Create an Options object with default values for all fields.
+        // 使用默认值构造Options
         Options();
 
-        // -------------------
-        // Parameters that affect behavior
-
-        // Comparator used to define the order of keys in the table.
-        // Default: a comparator that uses lexicographic byte-wise ordering
-        //
-        // REQUIRES: The client must ensure that the comparator supplied
-        // here has the same name and orders keys *exactly* the same as the
-        // comparator provided to previous open calls on the same DB.
+        // Comparator 用来定义keys值在table中的排序方式
+        // Default: 默认提供的对比工具是按照字典顺序进行排序的，也就是字典中字幕的排列顺序进行排序
+        // 需要用户保证所有打开数据的对比工具都是一致的
         const Comparator *comparator;
 
-        // If true, the database will be created if it is missing.
+        // 如果设置为true，当数据库丢失时会创建一个新的数据库
         bool create_if_missing = false;
 
-        // If true, an error is raised if the database already exists.
+        // 如果设置为true，当同名数据库已经存在就直接报错
         bool error_if_exists = false;
 
-        // If true, the implementation will do aggressive checking of the
-        // data it is processing and will stop early if it detects any
-        // errors.  This may have unforeseen ramifications: for example, a
-        // corruption of one DB entry may cause a large number of entries to
-        // become unreadable or for the entire DB to become unopenable.
+        // 如果设置为true，将会实现对正在设置的数据进行检查，如果检测到任何错误将会提前停止
+        // 这可能会导致不可预料的异常，例如：一个损坏的DB表项，可能造成大量的DB表项不可读
+        // 甚至导致整个数据库不可打开
         bool paranoid_checks = false;
 
         // Use the specified object to interact with the environment,

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ class NoDestructor {`
`109`	`109`
`110`	`110`	`总结`
`111`	`111`
`112`		-这一个实例的创建使用了三个比较重要的C++知识点，alignof取结构体对齐长度，`new（placement new）` 来实现预分配内存的new，在结合 `aligned_storage` 来保证已有对象内存绝对大于等于需要申请对象的内存，然后经过饿汉式单例模式封装，经过以上几个步骤之后，一个能长久陪伴数据库句柄的对比工具便诞生了。
	`112`	+在整个levelDB中有很多地方都用了这个特性进行单例的创建，在这个实例的创建中使用了三个比较重要的C++知识点，alignof取结构体对齐长度，`new（placement new）` 来实现预分配内存的new，在结合 `aligned_storage` 来保证已有对象内存绝对大于等于需要申请对象的内存，然后经过饿汉式单例模式封装，经过以上几个步骤之后，一个能长久陪伴数据库句柄的对比工具便诞生了。
`113`	`113`
`114`	`114`
`115`	`115`