Re: [讨论] 要不要写注解

楼主: shter (飞梭之影)   2019-10-27 10:32:36
借这问题问一下
程式要不要写注解有争议,但设定档 (如 httpd.conf ) 都是有注解的
不过近年来因为 JSON 格式与 web 的流行
不少专案开始把新的设定档用 json 的树状结构写了
问题是
过去 .conf 的设定档只要加一行 # 开头的就变注解了
但在 json 里似乎也不吃 javascript 的 // 或 /* */ ??
最后看到的解法大部分是 key 写成
"//_name": "description....",
或是
"//": "name and description..,
相比起程式码
其实设定档也有不少注解需求要说明这个值是做什么的,定义的格式及数值范围为何
不知道大家是怎么在 json 格式档案写注解?
作者: petercoin (彼得币)   2019-10-27 11:10:00
我都参考VSCode的设定档内的写法
作者: abccbaandy (敏)   2019-10-27 11:13:00
解法就是换一种格式阿XD
作者: x000032001 (版废了该走了)   2019-10-27 11:36:00
用yaml或toml就好了啊
作者: touurtn (vv)   2019-10-27 11:39:00
现在设定档比较流行YAML或TOML吧
作者: othree (OOO)   2019-10-27 14:05:00
直接用 js 档案格式 export 物件也可以,现在也很多这样的JSON 作者故意拿掉注解的,因为他发现有当 directive 用的JSON 比较适合资料交换用
作者: x246libra (楓)   2019-10-27 14:25:00
请问楼上 export 物件后,要怎么给其他程式使用?通常似乎都是直接读取config.json 如果换成config.js原本的程式该怎么拿到资料 不懂js 所以请叫你
作者: othree (OOO)   2019-10-27 23:32:00
我是假设是 nodejs 的程式,所以直接 import 就可以了
作者: sxy67230 (charlesgg)   2019-10-28 16:50:00
我还没遇过设定档用json写的,我是后端的yaml还是主流。早期写c++是用一个constants写,现在这种写法比较少了。
作者: Phenomenon (Kuma)   2019-10-28 21:48:00
用 yaml 或 jsonnet

Links booklink

Contact Us: admin [ a t ] ucptt.com