專案那點兒事 山寨篇(注釋不是程式設計師的負擔)

2022-01-30 23:16:03 字數 1244 閱讀 8481

一直在關注羽之的專案那點事系列,寫的非常好,推薦大家關注下。在標準化的意義

至於作者、日期

這個我們會在vs中新建模板頁來解決,建立新的項也會自動的生成這些資訊。

修改記錄不屬於強制注釋

其他的比如類功能是必須的(輸出一般也寫在功能注釋中),因為程式設計師在實現以前就要知道功能是做什麼的。

引數列表也是必須項,這個也是寫程式時候邊寫邊改的。不過通過vs的自動注釋功能只需要填寫引數的功能即可。

最後要做的就是資料字典,這個我們還是依賴**生成器,規則的命名會自動生成注釋,非標準的命名會留出空餘,讓程式設計師自己填寫。

當然其他的一些注釋則是根據專案的大小,時間進度的因素彈性控制的。

這裡我們應用了很多技巧,例如**生成,vs頁面模板等,有了這些東東我們的程式設計師在開發的時候做注釋花不了多少時間,大多數都是自動生成的,一般乙個模組下來也就個把分鐘。

而程式設計師的模組在寫完以後很少有不需要修改的,有了這些注釋不僅程式設計師不會感到有負擔,再日後修改的時候也會覺得輕鬆很多,所以我團隊裡的開發人員已經自覺的形成維護注釋的習慣了。

業務層部分

此前我們已將實現了作者、日期等的自動化。

在編寫業務層的時候大部分模組都是重複的,比如許可權,資訊發布,公文流轉,進銷存等,這些都可以形成基礎模組,這些基礎模組由固定的人來維護,由於可能會定期修改,所以這些維護的工作人員即使你不規定他們也會自己新增注釋(要選對人,有責任感的)。

另外,開發需要一套命名規範,可以用微軟的指導性檔案,也可以公司統一編寫乙份,這樣大家在看到命名的時候只需要配合很少的注釋即可快速上手。

至於特殊的業務比如統計報表,個性模組這些就沒辦法了。但是由於這些模組只會被很少的使用者用到,所以相對來說復用性不是很好,只需要簡單的注釋即可。

要求程式設計師標註方法功能,引數列表,模組功能即可,這些工作基本不會加重程式設計師的負擔,而稍微上手的程式也會自覺填寫的。

其實自動化注釋工具只是乙個輔助,只能進行共性**和功能的輔助。最重要的還是在讓程式設計師參與這些共性**的開發時養成注釋的習慣,讓程式設計師自動、自覺的去寫注釋,這才是自動化注釋的終極目標(失少是我的)。

關於注釋的長度

我們編寫注釋的習慣是簡短明了,乙個介面、乙個方法的注釋在vs中輸入///以後會自動生成乙個模板,程式設計師只需要填寫就可以了。功能只需要一句話,比如 //阿拉伯數字到漢字的轉換。

引數也是,之後再呼叫的時候注釋會和.net提供的其他方法一樣顯示這些注釋內容。

模組方面也是類似,只是多了一些資訊,比如作者,時間等等。

所以,並不會有冗長的內容,也不會讓閱讀者覺得累贅。

iOS螢幕適配那點兒事

首先要明白幾個概念 座標 表示螢幕的物理尺寸大小 畫素 表示螢幕的大小,和座標之間的比值對我們很重要,一般是1 1或1 2.ppi 就是座標和畫素的比值。ios螢幕適配可以分為兩部分,一 螢幕大小的適配,二 畫素的適配。螢幕大小的適配 5 5s 5c之後,因為螢幕的大小改變了,使用絕對定位是不可行的...

雲儲存市場的那點兒事

中云網 原創 據市場研究公司idc最近發表的研究報告顯示,公共雲服務提供商從2010年至2015年在儲存硬體 軟體和專業服務方面的開支將以平均每年23.6 的速度增長。idc儲存系統和執行戰略部副總裁richard villars表示,到2015年,全球公共雲和私有雲儲存開支將達到226億美元。雲儲...

《BI那點兒事》Cube的儲存

原文 bi那點兒事 cube的儲存 關係 olap rolap rolap的基本資料和聚合資料均存放在關聯式資料庫中 rolap 儲存模式使得分割槽的聚合儲存在關聯式資料庫的表 在分割槽資料來源中指定 中。但是,可為分割槽資料使用 rolap 儲存模式,而不在關聯式資料庫中建立聚合。使用 rolap...