看板
[ Soft_Job ]
討論串[討論] 要不要寫註解
共 9 篇文章
內容預覽:
借這問題問一下. 程式要不要寫註解有爭議，但設定檔 (如 httpd.conf ) 都是有註解的. 不過近年來因為 JSON 格式與 web 的流行. 不少專案開始把新的設定檔用 json 的樹狀結構寫了. 問題是. 過去 .conf 的設定檔只要加一行 # 開頭的就變註解了. 但在 json 裡似
(還有412個字)
內容預覽:
整理一下討論中主張要寫註解的理由，有些比較不必要. 1. 程式的why 「寫個一行10~20個字這個method幹麻」. 這個可以寫在test spec中。特別是BDD的testing lib的desribe還可以套很多層. 應該夠你寫了. 2. 責任分配 「// 此功能因某某某要求故加上」. 這個
(還有227個字)
內容預覽:
命名好不用寫註解這是不可能的. 註解就是白話文，有些超級複雜的東西不管命名多好都不可能看得懂. 例如「相對論」這個命名， Relative_Theory ,好棒的命名阿，這樣就看懂了？. 神。. 當然上面的例子是有點誇張，再比方寫會計軟體，GAAP，IFRS制度變換，摘要肯定很長. ，細節就在註解內
(還有85個字)
內容預覽:
當然是要寫. 但不是每個method都寫. 你說的內容感覺比較像summary. summary當然是必寫. 你就稍微寫個一行10~20個字這個method幹麻的. 也花不到兩分鐘吧. 幫別人也避免自己太久沒看忘記了不是很好嗎?. 某些走火入魔的人就是拿1的觀點堅持不寫summary. 你只要寫了就
(還有340個字)
內容預覽:
我們公司反而是比較流行不寫註解. 但有另外的對應方法. 有需求或有bug一律開ticket. 討論盡量在ticket上 而不用信件來往. 有什麼附件比如log也可以加在JIRA上. 還可以在confluence上畫好UML圖. 例如class diagram, sequence diagram. 上
(還有378個字)