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