PTT職涯區 / Soft_Job (軟體人)

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

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