C# 項目提交過程中感受
新到一家互聯網公司,昨天第一次提交代碼,遇到了不少問題,而且大多數是代碼格式問題,特此將范的錯誤記錄下來,自我警示。
1. 代碼對齊,這個雖然一直也都在注意,不過還是有一行代碼沒有對齊,以後注意吧,提交前一定要先檢查一下。
2. 多余的空格,在代碼編寫的過程中,會不經意間,多敲幾下Space鍵,用VS的時候也看不出來,但是一旦提交到SVN上面,就會顯示紅色。
3. 之前的公司喜歡將一些暫時用不到的代碼注釋掉,但是目前的boss,喜歡清清爽爽,注釋掉的代碼全部清除。
4. 多余的空行,之前不同功能代碼間喜歡用空行分隔,多一行少一行也感覺沒有什麼,目前是必須一行。
5. 每個類,每個接口多多少少都會引入命名空間,代碼提交前需要將多余的命名空間清除,其他的進行排序。
6. 代碼編寫時盡量避免頭重腳輕。
7. 參考別人的代碼,要符合自己的情景,包括功能、變量命名,條件........
8. 注釋雙斜槓後面要空一格。
9. 代碼要簡單實用,效率高。
10.編寫軟件的幫助文檔,一定要對各個參數解釋清楚,包括:具體含義,類型,是必須還是可選,范圍等等,給出的示例,一定要和實際相符合。還有一些注意事項。
11.GET、DELETE的BodyStyle=WebMessageBodyStyle.Bare;
PUT、POST的BodyStyle=WebMessageBodyStyle.WrappedRequest;
GET的返回類型與實際需求相關,POST一般返回添加字段的ID,PUT、DELETE一般返回操作結果。
以上是這次代碼提交出現的一些錯誤,謹記,不要再次出現。