作者shter (飞梭之影)
看板Soft_Job
标题Re: [讨论] 要不要写注解
时间Sun Oct 27 10:32:36 2019
借这问题问一下
程式要不要写注解有争议，但设定档 (如 httpd.conf ) 都是有注解的
不过近年来因为 JSON 格式与 web 的流行
不少专案开始把新的设定档用 json 的树状结构写了
问题是
过去 .conf 的设定档只要加一行 # 开头的就变注解了
但在 json 里似乎也不吃 javascript 的 // 或 /* */ ??
最後看到的解法大部分是 key 写成
"//_name":
"description....",
或是
"//":
"name and description..,
相比起程式码
其实设定档也有不少注解需求要说明这个值是做什麽的，定义的格式及数值范围为何
不知道大家是怎麽在 json 格式档案写注解?
--
[LINE 台币汇率机器人] https://line.me/R/ti/p/sCsZnuBg5V
即时台银汇率，可计算退税价格，出国血拼直接输入货架金额查询退税後台币价。
打招呼会告诉你使用说明 讲日币就会将汇率切成日币模式 之後打数字就会自动转换
===============================================================
新增笔记本功能可纪录外币消费、比价用途，并利用所查价格开启团购功能
https://youtu.be/ttayJLYa7Oc
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 111.250.17.73 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1572143564.A.2D0.html
1F：→ petercoin: 我都参考VSCode的设定档内的写法 10/27 11:10
2F：→ abccbaandy: 解法就是换一种格式阿XD 10/27 11:13
3F：→ x000032001: 用yaml或toml就好了啊 10/27 11:36
4F：推 touurtn: 现在设定档比较流行YAML或TOML吧 10/27 11:39
5F：推 othree: 直接用 js 档案格式 export 物件也可以，现在也很多这样的 10/27 14:05
6F：→ othree: JSON 作者故意拿掉注解的，因为他发现有当 directive 用的 10/27 14:06
7F：→ othree: JSON 比较适合资料交换用 10/27 14:07
8F：→ x246libra: 请问楼上 export 物件後，要怎麽给其他程式使用? 10/27 14:25
9F：→ x246libra: 通常似乎都是直接读取config.json 如果换成config.js 10/27 14:26
10F：→ x246libra: 原本的程式该怎麽拿到资料 不懂js 所以请叫你 10/27 14:27
11F：推 othree: 我是假设是 nodejs 的程式，所以直接 import 就可以了 10/27 23:32
12F：推 sxy67230: 我还没遇过设定档用json写的，我是後端的yaml还是主流。 10/28 16:50
13F：→ sxy67230: 早期写c++是用一个constants写，现在这种写法比较少了。 10/28 16:50
14F：推 Phenomenon: 用 yaml 或 jsonnet 10/28 21:48