2010-05-25 27 views
7

即使僅在更改一些註釋之前,是否在將代碼提交到存儲庫之前編譯代碼?我知道評論通常會被編譯器忽略,但我發現自己經常出於習慣。僅在註釋更改時編譯代碼

回答

12

在每次提交之前編譯代碼是一種很好的做法。有時候你會意外地編輯除了註釋之外的東西,從而破壞代碼。編譯通常非常快,有助於避免不必要的痛苦。這就是爲什麼我在提交之前每次都要編譯的原因。

+1

此外,如果根據評論內容生成任何文檔,最好也檢查一下。例如,我工作的一些文檔是根據模塊註釋和函數頭註釋生成的 - 每個文檔都有文檔生成器期望的一組標籤。 – Sparky 2010-05-25 14:55:58

+0

+1。實際上,我們通過在允許簽入完成之前自動編譯來強制執行此操作,並拒絕甚至警告。最重要的是,如果一個模塊打破了一夜之間的構建,第二天就會對責任方有嚴肅的說法。 – paxdiablo 2011-02-15 09:07:29

1

我承諾的git,然後把我的改變爲SVN服務器所有的人使用,所以我有一個腳本,自動重建並運行測試和推動,如果一切順利通過

1

使用svn我明白爲什麼有人可能不如果需要五分鐘,則需要經歷一個編譯週期。但是,如果是這樣的話,也許你可以把所有的改變都收集到一個單獨的編譯/提交操作中。

1

每一個承諾應建設主線上的一體化機

+0

這是如何回答他的問題?我們也這樣做,但是這並不妨礙我在我的機器上構建 – 2010-05-25 14:43:11

+0

如果開發人員機器之間沒有環境差異,人們應該在他們提交之前進行更新和構建,並且涉及評論,最終如果您選擇或者忘記構建,那麼如果出現問題,您的持續集成將被捕獲。 – 2010-05-25 14:52:35

2

我總是在提交之前,編譯,工作編譯的程序集應始終與工作源代碼。在實踐中,如果您只是在更改註釋,您不需要需要。但多久評論一次你會改變?

請記住,在.NET中,您可以添加編譯器可能會讀取的XML註釋以創建彙編文檔。很顯然,在改變這些類型的評論時需要編譯。

+0

您將編譯後的程序集提交到版本控制? – Stephen 2010-05-25 14:47:37

+0

對不起,措辭嚴厲。將修改。 – 2010-05-25 14:48:48

+0

「但是多久評論一次你會改變?」 我喜歡修改註釋中的拼寫錯誤或更新與相應代碼不同步的註釋。我覺得這很重要,所以在將來其他開發人員不必浪費時間被不正確的評論弄糊塗了。 – jbgo 2010-05-27 11:16:23

1

例如在.Net中,如果您不小心,可能會弄亂XML註釋並檢查不必要的編譯器警告。因此,在提交之前每次編譯代碼是一個好主意(因爲它是在提交之前運行測試)。

1

任何一半體面的編譯器在只有註釋發生變化時將幾乎爲零時重新編譯代碼。 第一次解析器傳遞應該注意到沒有函數已經改變並停止。

1

從個人經驗來看,過度勞累的大腦往往不僅僅註釋而是注意不到注意。即使需要一段時間,編譯它也可能會更好。將拯救他人頭痛,保護您的信譽。