2012-09-05 29 views
1

在許多編程語言中,字段和方法可以自由排列,但順序會影響代碼的可讀性。 您應用哪種訂購策略?如何對源代碼文檔中的字段和方法進行排序?

背景:我們(來自特里爾大學的一組研究人員)已經研究了不同開源項目的代碼,並試圖找出應用什麼策略。但正如你所想象的那樣,從代碼中提取這些信息是很困難的。現在,我們對您應用的具體策略感興趣,並希望在此共享和討論此信息。請在我們的project page找到更多信息。

+3

首先是公共方法,剩下的是按照這些公共/接口方法出現的順序。至於字段 - 頂部的配置字段;其餘的按邏輯和按照外觀順序進行分組。 –

回答

1
  • 私有字段第一
  • 公共字段(如有的話)
  • 屬性(如果有的話,例如,在C#)或簡單的getter/setter

  • 構造

  • 公共方法
  • 私人方法接近他們出現在公共方法中(功能性編程語言甚至在公共方法中ods如果可能的話)

此外,我嘗試命令每個這些部分的語義或其重要性的類。我真的試圖構建自己的代碼,以便快速獲得重要事物的概覽。然而,在非常大的班級中,我有我的問題需要遵循我的策略,然後我經常使用大綱來獲取字段或方法,而不是通過滾動來查找它們。

相關問題