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

作者: YAYA6655 (YAYA)   2019-10-27 02:43:38
命名好不用寫註解這是不可能的
註解就是白話文,有些超級複雜的東西不管命名多好都不可能看得懂
例如「相對論」這個命名, Relative_Theory ,好棒的命名阿,這樣就看懂了?
神。
當然上面的例子是有點誇張,再比方寫會計軟體,GAAP,IFRS制度變換,摘要肯定很長
,細節就在註解內。
又比方寫金融軟體,寫到什麼動態穩定措施,價格瞬間偏移等,都是專有的觀念,這種
也是無論怎麼命名都不可能看懂,因為接手的人要是沒有背景知識,就很棘手了。
不寫註解,應該是只寫資料庫的CRUD才會這麼認為吧。這種的確不用寫。 :D
作者: itoni (每天都過得很混)   2019-10-27 03:13:00
你說的這種東西應該寫在文件而不是註解吧
作者: senjor (哞哞)   2019-10-27 03:26:00
我是覺得至少要寫到你引用外部含式庫註解的內容程度啦
作者: superpai (超級白)   2019-10-27 04:20:00
這些寫在wiki而不是註解好嗎
作者: knives   2019-10-27 08:04:00
有些沒sense的主管就會這樣
作者: littlethe (東周流浪漢)   2019-10-27 09:01:00
唉喓,所以註解就要寫請參考那一個文件,註解還是要寫呀
作者: BBSealion (海獅)   2019-10-27 10:04:00
註解跟文件又是一場災難XD 時常code, 註解, 文件無法良好的保持一致,所以也有提出註解=文件的套件,但也不一定好用,這只能靠工程師自己的美德了XDD
作者: MonyemLi (life)   2019-10-27 12:34:00
問題不是在於不懂相對論的人怎麼會維護這程式碼
作者: littlethe (東周流浪漢)   2019-10-27 13:05:00
不一致會發生,但有寫就有線索可以查,總比什麼都沒有好
作者: CoNsTaR ((const *))   2019-10-27 19:42:00
不知道從哪裡開始吐槽...
作者: YAYA6655 (YAYA)   2019-10-27 22:28:00
對阿,哈,至少要摘要一行,註解一行
作者: Ghamu (貓丸)   2019-10-30 05:02:00
不一致的問題在於誤導 可能把問題越弄越糟

Links booklink

Contact Us: admin [ a t ] ucptt.com