docs: change comment style

example/config.ini

@@ -1,152 +1,152 @@
-; 配置示例
-; 注: 命令中直接输入的选项优先级高于配置文件
-;     布尔型的设置仅当为true时才为真
-; 支持环境变量(全局可用) 及 家目录 ~ (仅能在路径类配置) 如:
-; pac-proxy = "SOCKS5 ${PROXY_HOST}:${PROXY_PORT}"
-; output = ${HOME}/pac.js
-; outtut = ~/pac.js
+# 配置示例
+# 注: 命令中直接输入的选项优先级高于配置文件
+#     布尔型的设置仅当为true时才为真
+# 支持环境变量(全局可用) 及 家目录 ~ (仅能在路径类配置) 如:
+# pac-proxy = "SOCKS5 ${PROXY_HOST}:${PROXY_PORT}"
+# output = ${HOME}/pac.js
+# outtut = ~/pac.js
 
 
-; 通用配置节点
-; [job]节点使用其值作为默认值
+# 通用配置节点
+# [job]节点使用其值作为默认值
 [config]
-; gfwlist获取相关设置
+# gfwlist获取相关设置
 
-; 完全禁止使用gfwlist 默认 false
-; gfwlist-disabled = false
+# 完全禁止使用gfwlist 默认 false
+# gfwlist-disabled = false
 
-; gfwlist文件网址，留空使用默认，值为`-`则表示不在线获取
+# gfwlist文件网址，留空使用默认，值为`-`则表示不在线获取
 gfwlist-url = https://raw.githubusercontent.com/gfwlist/gfwlist/master/gfwlist.txt
 
-; 获取gfwlist时的代理
-; 默认: 空
-; gfwlist-proxy = SOCKS5://127.0.0.1:9527
+# 获取gfwlist时的代理
+# 默认: 空
+# gfwlist-proxy = SOCKS5://127.0.0.1:9527
 
-; gfwlist本地文件，在线地址获取失败时读取本地
-; 默认: -
+# gfwlist本地文件，在线地址获取失败时读取本地
+# 默认: -
 gfwlist-local = ./gfwlist-local.txt
 
-; 更新本地gfwlist文件
-; 当成功获取在线的gfwlist文件并且gfwlist-local存在，是否更新gfwlist-local
-; 默认: false
+# 更新本地gfwlist文件
+# 当成功获取在线的gfwlist文件并且gfwlist-local存在，是否更新gfwlist-local
+# 默认: false
 gfwlist-update-local = true
 
-; 保存解码后的gfwlist文件 用于开发测试
-; 默认: 空
+# 保存解码后的gfwlist文件 用于开发测试
+# 默认: 空
 gfwlist-decoded-save = ./gfwlist-decoded.txt
 
-; etag缓存加速 默认: false
+# etag缓存加速 默认: false
 etag-cache = true
 
-; 用户自定义规则相关
-
-; 规则，支持使用`,`或换行分割多个规则
-; urer-rule = RULE1,RULE2,RULE3
-;   RULE4
-;   RULE5
-;   RULE6
-
-; 规则文件，可使用`,`或换行分割多个文件
-; user-rule-from = /PATH/TO/USER/RULE/FILE_1,/PATH/TO/USER/RULE/FILE_2
-;   /PATH/TO/USER/RULE/FILE_3
-;   /PATH/TO/USER/RULE/FILE_4
-
-; 默认输出格式，当下面的format节点没有指定格式时使用该值，最好不要在[config]中设置
-; format = pac
-
-; 输出文件 该值为空或`-`则输出到stdout
-; output = -
-
-
-; 格式定义, 可重复, 所有选项可使用, 优先级高于[config]节点
-; 支持[job]及[job:FORMAT]形式
-; 每个节点表示一个任务, 因而多次使用可生成多个文件
-; 注意节点中的FORMAT优先级高于config节点的format值但低于本节点的format值，如:
-;
-; [config]
-; format = fmt1
-; [job:fmt2]
-; format = fmt3
-;
-; job:fmt2节点中选项format的值为 fmt3
-;! 建议不要在节点名和选项中重复指定FMT
-
-; 目前支持格式的具体配置
-; ===
-; pac: 代理自动配置文件
+# 用户自定义规则相关
+
+# 规则，支持使用`,`或换行分割多个规则
+# urer-rule = RULE1,RULE2,RULE3
+#   RULE4
+#   RULE5
+#   RULE6
+
+# 规则文件，可使用`,`或换行分割多个文件
+# user-rule-from = /PATH/TO/USER/RULE/FILE_1,/PATH/TO/USER/RULE/FILE_2
+#   /PATH/TO/USER/RULE/FILE_3
+#   /PATH/TO/USER/RULE/FILE_4
+
+# 默认输出格式，当下面的format节点没有指定格式时使用该值，最好不要在[config]中设置
+# format = pac
+
+# 输出文件 该值为空或`-`则输出到stdout
+# output = -
+
+
+# 格式定义, 可重复, 所有选项可使用, 优先级高于[config]节点
+# 支持[job]及[job:FORMAT]形式
+# 每个节点表示一个任务, 因而多次使用可生成多个文件
+# 注意节点中的FORMAT优先级高于config节点的format值但低于本节点的format值，如:
+#
+# [config]
+# format = fmt1
+# [job:fmt2]
+# format = fmt3
+#
+# job:fmt2节点中选项format的值为 fmt3
+#! 建议不要在节点名和选项中重复指定FMT
+
+# 目前支持格式的具体配置
+# ===
+# pac: 代理自动配置文件
 [job:pac]
-; PAC文件中的代理 必须 默认: 空
-; 注: 如果配置的是多条可选项，最好使用引号包围，如下面的例子
+# PAC文件中的代理 必须 默认: 空
+# 注: 如果配置的是多条可选项，最好使用引号包围，如下面的例子
 pac-proxy = "SOCKS5 127.0.0.1:1080; DIRECT"
-; 压缩，默认 false
-; pac-compress = false
-; 精确匹配 默认 false
-; pac-precise = false
+# 压缩，默认 false
+# pac-compress = false
+# 精确匹配 默认 false
+# pac-precise = false
 output = ./pac.js
 
-; 相同的格式可重复出现
+# 相同的格式可重复出现
 [job:pac]
-; 配置可重复出现，优先级高于[config]节点下的值
+# 配置可重复出现，优先级高于[config]节点下的值
 gfwlist-url = https://raw.githubusercontent.com/gfwlist/tinylist/master/tinylist.txt
 gfwlist-local = ./tinylist-local.txt
 gfwlist-update-local = true
 gfwlist-decoded-save = ./tinylist-decoded.txt
 pac-proxy = "SOCKS5 127.0.0.1:1080; DIRECT"
 output = ./pac-tiny.js
 
-; list: 规则列表
-; 与GFWLIST相似的base64编码
+# list: 规则列表
+# 与GFWLIST相似的base64编码
 [job:list]
 output = ./list.txt
 
-; 明文，不进行base64编码
+# 明文，不进行base64编码
 [job:list]
 list-raw = true
 output = ./list-raw.txt
 
-; dnsmasq: DNSmasq的DNS服务器、ipset、nftset
+# dnsmasq: DNSmasq的DNS服务器、ipset、nftset
 [job:dnsmasq]
-; 解析规则的域名使用的dns服务器，形式：HOST#PORT
-; 详见dnsmasq手册的`--server`参数的说明
+# 解析规则的域名使用的dns服务器，形式：HOST#PORT
+# 详见dnsmasq手册的`--server`参数的说明
 dnsmasq-dns = "127.0.0.1#5353"
-; nftset
-; 详见dnsmasq手册的`--nftset`参数的说明
+# nftset
+# 详见dnsmasq手册的`--nftset`参数的说明
 dnsmasq-nftset = "4#inet#GFW#GFWLIST,6#inet#GFW#GFWLIST6"
-; ipset
-; 详见dnsmasq手册的`--ipset`参数的说明
+# ipset
+# 详见dnsmasq手册的`--ipset`参数的说明
 dnsmasq-ipset = "GFWLIST,GFWLIST6"
 output = ./dnsmasq.conf
 
-; v2ray: v2ray的规则配置文件
+# v2ray: v2ray的规则配置文件
 [job:v2ray]
-; 代理的标签
+# 代理的标签
 v2ray-proxy = proxy
-; 直连的标签 未指定时将不出现直连的规则 默认: 空
+# 直连的标签 未指定时将不出现直连的规则 默认: 空
 v2ray-direct = direct
-; 默认标签 未指定不输出默认规则
-; TIP：如要指定 一般与直连标签相同
+# 默认标签 未指定不输出默认规则
+# TIP：如要指定 一般与直连标签相同
 v2ray-default = direct
-; 输出格式 默认: json
-; v2ray-format = json
+# 输出格式 默认: json
+# v2ray-format = json
 output = ./v2ray.json
 
-; v2ray 输出yaml
+# v2ray 输出yaml
 [job:v2ray]
 v2ray-proxy = gfw
 v2ray-direct = direct
 v2ray-default = direct
 v2ray-format = yaml
 output = ./v2ray.yaml
 
-; ssacl: shadowsocks的访问控制列表
+# ssacl: shadowsocks的访问控制列表
 [job:ssacl]
 output = ./ss.acl
 
 [job:ssacl]
 ssacl-geocn = true
 output = ./ss-gencn.acl
 
-; ip输出
+# ip输出
 [job:ip]
 output = ./ip-cn.txt
 ip-cc = cn
@@ -188,22 +188,22 @@ copy-source = https://raw.githubusercontent.com/sapics/ip-location-db/main/geoli
 output = ./geolite2-country-ipv4.csv
 
 [job:qtx]
-; qtx-no-direct = false
-; qtx-no-final = false
+# qtx-no-direct = false
+# qtx-no-final = false
 output = ./quantumultx.conf
 
 [job:shadowrocket]
-; shadowrocket-policy = PROXY
-; shadowrocket-no-direct = false
-; shadowrocket-no-final = false
-; shadowrocket-set = false
+# shadowrocket-policy = PROXY
+# shadowrocket-no-direct = false
+# shadowrocket-no-final = false
+# shadowrocket-set = false
 output = ./shadowrocket.conf
 
 [job:surge]
-; surge-policy = PROXY
-; surge-no-direct = false
-; surge-no-final = false
-; surge-set = false
+# surge-policy = PROXY
+# surge-no-direct = false
+# surge-no-final = false
+# surge-set = false
 output = ./surge.conf
 
 [job:surge]
@@ -212,9 +212,9 @@ output = ./surge-set.conf
 
 [job:wingy]
 output = ./wingy.yaml
-; adapter选项
-; wingy-adapter-opts =
-; 匹配规则使用的adapter ID
-; wingy-rule-adapter-id =
-; 自定义模板文件
-; template = /PATH/TO/WINGY/TEMPLATE/FILE
+# adapter选项
+# wingy-adapter-opts =
+# 匹配规则使用的adapter ID
+# wingy-rule-adapter-id =
+# 自定义模板文件
+# template = /PATH/TO/WINGY/TEMPLATE/FILE

example/server/config.ini

@@ -1,25 +1,25 @@
 [server]
-; 授权密令
-; 启用时除首页、服务端规则查看页面外均需要token才能访问
-; 为空则禁用，任何人都可以访问
+# 授权密令
+# 启用时除首页、服务端规则查看页面外均需要token才能访问
+# 为空则禁用，任何人都可以访问
 auth-token = my_auth_token
-; 生成文件所在目录
-; 只用在这个目录中的文件才有可能被访问到
-; 因此后面定义的生成文件必须放在这个目录中
+# 生成文件所在目录
+# 只用在这个目录中的文件才有可能被访问到
+# 因此后面定义的生成文件必须放在这个目录中
 target-path = /tmp
-; 启动时生成
+# 启动时生成
 build-on-start = true
-; 自动生成间隔 秒 小于等于0时不自动生成
+# 自动生成间隔 秒 小于等于0时不自动生成
 autobuild-interval = 600
-; 是否监控文件更改
+# 是否监控文件更改
 watch-enabled = true
-; 额外需要监控的文件
-; 默认当前的配置文件及user-rule-from都会被监控
+# 额外需要监控的文件
+# 默认当前的配置文件及user-rule-from都会被监控
 watch-extra-files =
 
-; 服务端规则相关
-; 启用则可在线编辑自定义规则
-; 规则文件保存于`target-path`目录下的server-rules.txt文件
+# 服务端规则相关
+# 启用则可在线编辑自定义规则
+# 规则文件保存于`target-path`目录下的server-rules.txt文件
 server-rule-enabled = true
 
 [server-pac]
@@ -33,18 +33,18 @@ jmbp = "pac.tpl.js __PROXY__=SOCKS5+127.0.0.1%3A9527%3B+DIRECT"
 gwd = "dnsmasq.conf"
 
 [config]
-; gfwlist-disabled = true
-; proxy = SOCKS5://127.0.0.1:9527
-; gfwlist-url = https://cdn.jsdelivr.net/gh/gfwlist/gfwlist/gfwlist.txt
+# gfwlist-disabled = true
+# proxy = SOCKS5://127.0.0.1:9527
+# gfwlist-url = https://cdn.jsdelivr.net/gh/gfwlist/gfwlist/gfwlist.txt
 gfwlist-local = /tmp/gfwlist.txt
 gfwlist-update-local = true
 gfwlist-decoded-save = /tmp/gfwlist-decoded.txt
 
 etag-cache = true
 
 # user-rule-from =
-#     /Users/JinnLynn/Developer/Web/server.afvisual/etc/genpac/user-rule.d
-#     /Users/JinnLynn/Developer/Web/server.afvisual/etc/genpac/user-rules-private.txt
+#     /PATH/TO/DIR/
+#     /PATH/TO/FILE
 
 
 [job:pac]