Re: [討論] 要不要寫註解

看板Soft_Job作者 (飛梭之影)時間6年前 (2019/10/27 10:32), 編輯推噓5(5推 0噓 9→)
留言14則, 8人參與, 6年前最新討論串9/9 (看更多)
借這問題問一下 程式要不要寫註解有爭議，但設定檔 (如 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://www.ptt.cc/bbs/Soft_Job/M.1572143564.A.2D0.html
→
10/27 11:10, 6年前 , 1F
我都參考VSCode的設定檔內的寫法
10/27 11:10, 1F
→
10/27 11:13, 6年前 , 2F
解法就是換一種格式阿XD
10/27 11:13, 2F
→
10/27 11:36, 6年前 , 3F
用yaml或toml就好了啊
10/27 11:36, 3F
推
10/27 11:39, 6年前 , 4F
現在設定檔比較流行YAML或TOML吧
10/27 11:39, 4F
推
10/27 14:05, 6年前 , 5F
直接用 js 檔案格式 export 物件也可以，現在也很多這樣的
10/27 14:05, 5F
→
10/27 14:06, 6年前 , 6F
JSON 作者故意拿掉註解的，因為他發現有當 directive 用的
10/27 14:06, 6F
→
10/27 14:07, 6年前 , 7F
JSON 比較適合資料交換用
10/27 14:07, 7F
→
10/27 14:25, 6年前 , 8F
請問樓上 export 物件後，要怎麼給其他程式使用?
10/27 14:25, 8F
→
10/27 14:26, 6年前 , 9F
通常似乎都是直接讀取config.json 如果換成config.js
10/27 14:26, 9F
→
10/27 14:27, 6年前 , 10F
原本的程式該怎麼拿到資料 不懂js 所以請叫你
10/27 14:27, 10F
推
10/27 23:32, 6年前 , 11F
我是假設是 nodejs 的程式，所以直接 import 就可以了
10/27 23:32, 11F
推
10/28 16:50, 6年前 , 12F
我還沒遇過設定檔用json寫的，我是後端的yaml還是主流。
10/28 16:50, 12F
→
10/28 16:50, 6年前 , 13F
早期寫c++是用一個constants寫，現在這種寫法比較少了。
10/28 16:50, 13F
推
10/28 21:48, 6年前 , 14F
用 yaml 或 jsonnet
10/28 21:48, 14F
‣ 更多 shter 的文章
文章代碼(AID): #1TjG7CBG (Soft_Job)
討論串 (同標題文章)
完整討論串 (本文為第 9 之 9 篇)：
排序： 最新先 | 最舊先 | 留言數
在新視窗開啟完整討論串 (共9篇)
‣ 更多 shter 的文章
文章代碼(AID): #1TjG7CBG (Soft_Job)