鏈接代碼&文檔並讓它們處於最新狀態的最佳做法是什麼?你如何鏈接你的代碼和業務規則?
其實,在我的工作中,業務規則是不幸的是沒有明確的規定,所以我們的編碼過程中發現它們。 我知道這是不是那麼好,但我們的老闆爲他們提供像幽靈一樣...
我測試感染&我們使用維基Trac的。
我注意到,主流框架(彈簧等)緊他們的測試代碼&錯誤機智只是JIRA的bug ID。
您可能會建議僅評論我的代碼。
但讓我們假設你正在爲照顧人類的外星人設計一個應用程序。其中一些人沒有一個關於人類的線索。你知道你可能會與一些外星人開發者一起工作。
所以我們有一個HumanFactory創建一個人的骨骼,肉...
我可以總是評論類,但我知道它會需要大量的意見,以充分解釋什麼是人。它可能會發展。
我的例子聽起來幽默,但我有實驗上2年的項目,所有的業務規則是一些IT人裏面,沒有別的地方。他們看到它們很平凡或自然,因爲它們習慣於它們。
所以像報道JIRA錯誤的任何測試環節,我已經因子評分這一過程的。
*維基上的頁面將列出所有業務規則(BR)的唯一編號:BR1 ... BR101。任何BR都必須儘可能簡約。如果不是這樣的話,它會被分成更多的BR。
*任何測試將只有一個簡短的描述和評論,以規則的鏈接:見#BR45
你怎麼看待這個問題?任何其他的實踐?
預先感謝
我必須說,這更多的工作在理論而不是實際的路徑(在.NET世界)。除非,您的意思是通過評論內嵌文檔。即便如此,這僅適用於低級別,最多也就是「中級」文檔。 – 2010-10-23 17:33:07
而當你想了解一個概念時,你必須在代碼中挖掘,與文檔不同的是不包含目錄?我認爲這隻適用於litlle項目。我在談論業務規則而不是技術實現。 – 2010-10-23 17:35:12
程序員的目標應該是正確的,自我記錄的代碼。如果你有不止一個事實根源,你最終會發現它們不同步。 – 2010-10-23 17:38:01