作者YAYA6655 (YAYA)
看板Soft_Job
標題Re: [討論] 要不要寫註解
時間Sun Oct 27 02:43:38 2019
命名好不用寫註解這是不可能的
註解就是白話文，有些超級複雜的東西不管命名多好都不可能看得懂
例如「相對論」這個命名， Relative_Theory ,好棒的命名阿，這樣就看懂了？
神。
當然上面的例子是有點誇張，再比方寫會計軟體，GAAP，IFRS制度變換，摘要肯定很長
，細節就在註解內。
又比方寫金融軟體，寫到什麼動態穩定措施，價格瞬間偏移等，都是專有的觀念，這種
也是無論怎麼命名都不可能看懂，因為接手的人要是沒有背景知識，就很棘手了。
不寫註解，應該是只寫資料庫的CRUD才會這麼認為吧。這種的確不用寫。 :D
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 220.135.144.57 (臺灣)
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1572115420.A.123.html
1F：推 itoni: 你說的這種東西應該寫在文件而不是註解吧 10/27 03:13
2F：推 senjor: 我是覺得至少要寫到你引用外部含式庫註解的內容程度啦 10/27 03:26
3F：推 superpai: 這些寫在wiki而不是註解好嗎 10/27 04:20
4F：推 knives: 有些沒sense的主管就會這樣 10/27 08:04
5F：推 littlethe: 唉喓,所以註解就要寫請參考那一個文件,註解還是要寫呀 10/27 09:01
6F：推 BBSealion: 註解跟文件又是一場災難XD 時常code, 註解, 文件無法 10/27 10:04
7F：→ BBSealion: 良好的保持一致，所以也有提出註解=文件的套件，但也不 10/27 10:04
8F：→ BBSealion: 一定好用，這只能靠工程師自己的美德了XDD 10/27 10:04
9F：→ MonyemLi: 問題不是在於不懂相對論的人怎麼會維護這程式碼 10/27 12:34
10F：推 littlethe: 不一致會發生,但有寫就有線索可以查,總比什麼都沒有好 10/27 13:05
11F：噓 CoNsTaR: 不知道從哪裡開始吐槽... 10/27 19:42
12F：→ YAYA6655: 對阿，哈，至少要摘要一行，註解一行 10/27 22:28
13F：→ Ghamu: 不一致的問題在於誤導 可能把問題越弄越糟 10/30 05:02