修改文档

Author: CppCXY

README.md

@@ -28,6 +28,7 @@
 * [格式化行为介绍](docs/format_action.md)
 * [如何配置格式化](docs/format_config.md)
 * [代码诊断配置](docs/diagnosis_config.md)
+* [部分屏蔽格式化](docs/disable_format.md)
 * [auto import配置](docs/auto_import_config.md)
 # Contribute
 

README_EN.md

@@ -28,6 +28,7 @@ In addition to providing language service examples, the project also provides an
 * [Introduction to formatting behavior](docs/format_action_EN.md)
 * [How to configure formatting](docs/format_config_EN.md)
 * [Code diagnosis configuration](docs/diagnosis_config_EN.md)
+* [Disable format](docs/disable_format_EN.md)
 * [auto import configuration](docs/auto_import_config_EN.md)
 ## Contribute
 Any pr or issue are welcome 

docs/disable_format.md

@@ -0,0 +1,33 @@
+# 格式化屏蔽
+
+通常项目中存在一些不宜格式化的文件，或者在一个文件中一些语句的格式化需要例外的手动处理，对于这样的情况，该算法库依然提供一定的支持
+
+## 使用---@format
+
+遵循emmylua doc的方式，我实现了通过分析注释屏蔽格式化的方式。
+
+在需要屏蔽的语句上方加上`---@format disable-next`即可屏蔽该语句内的格式化。
+
+例如：
+```lua
+---@format disable-next
+local t =123
+
+```
+
+如果某语句块需要屏蔽则加上`---@format disable`即可屏蔽该语句块内的格式化.
+
+例如:
+```lua
+---@format disable
+
+local d = 123
+local cc=2313
+local ccc =13
+
+```
+
+## 注意
+
+1. 无论是否屏蔽格式化，被format注解屏蔽格式化的语句的缩进依然会被格式化，
+2. 屏蔽格式化的单位是语句，不是表达式，如果format注解写为内联注释，则屏蔽不会生效

docs/disable_format_EN.md

@@ -0,0 +1,33 @@
+# format disable
+
+Usually there are some files that are not suitable for formatting in the project, or the formatting of some statements in a file requires exceptional manual processing. For such cases, the algorithm library still provides certain support.
+
+## use ---@format
+
+Following the way of emmylua doc, I implemented the way of disable formatting by analyzing comments.
+
+Add `---@format disable-next` above the statement to be disable the formatting in the statement.
+
+E.g:
+````lua
+---@format disable-next
+local t=123
+
+````
+
+If a statement block needs to be disable-format, add `---@format disable` to header of block for disabled formatting.
+
+E.g:
+````lua
+---@format disable
+
+local d = 123
+local cc=2313
+local ccc =13
+
+````
+
+## Notice
+
+1. Regardless of whether the formatting is disable or not, the indentation of the statement masked by the format annotation will still be formatted.
+2. The unit of masking and formatting is a statement, not an expression. If the format annotation is written as an inline comment, the masking will not take effect.