簡體   English   中英

訂購Java方法最常用的方法是什么?

[英]What is the most common way of ordering Java methods?

訂購Java方法可能是有史以來最不重要的代碼風格問題,但我正在嘗試開發一種類似於大多數人所做的代碼風格。 它是迄今為止最流行的方法,首先聲明所有字段,然后是所有方法,所以我只會詢問方法。

現在我想知道如何訂購Java方法。 我可以想到兩個合理的基本方法:

  1. 通過可見性訂購方法(即首先公開,然后保護,然后私人或其他方式)
  2. 依賴順序排序方法(即方法a()調用方法b(),盡可能緊密地放在一起)

據我所知,第二種方法似乎更受歡迎。 盡管如此,在這兩種情況下都存在方向問題,大多數人使用的方法並不明確。 在第二種方法中,您可以在()上方或下方放置一個()。 我認為將b()放在a()上面(並最終將main()放在類文件的底部)在C中更常見,不確定C ++。 另一種方式是IMO從上到下更好地閱讀。 Java中最常用的方法是什么? 關於靜態字段/方法的任何特殊規則?

當我發現“邏輯上”是一個相對術語時,我“邏輯地”放棄了; 對於不同的程序員來說,一個程序員的邏輯並不總是合乎邏輯的。 如果我必須學習“邏輯排序”的含義,那么它就會失敗,成為一種“邏輯分類”的技術。

我更喜歡按字母順序排列我的方法和數據成員。 我認為字母,偽線性搜索是用英語思考的人的“自然”技術。 例如,嘗試對以下任何內容進行邏輯排序:百科全書,電話簿,聯系人電子郵件列表。

反對字母表的經典論據是[用蘇聯時代的俄語口音說話]“用於alfabet searchz的Ve haf IDE!在kode中是不需要的!” 我對這些論點的回答是“是的,斯大林先生。”但並非所有人都使用IDE來查看代碼。有些人仍然使用(並且喜歡)vi。我可能不是那些人之一,但我知道他們存在其他人已經了解到,當代碼按字母順序排列時,頁面向上和向下翻頁鍵可以很好地工作。“

我認為在底部添加getter,setter,equals,hashCode和toString是很有用的,因為這通常不是開發人員在它到位時非常關心的事情。

我傾向於使用選項1,但是使用一個不錯的IDE它真的不重要。

我傾向於使用選項1,但也嘗試邏輯地組織它們。
toString在底部簡單的東西在頂部,並致力於更專業的方法。

更重要的是你使用適當的JDoc注釋格式,然后一個體面的IDE應該能夠為你自動生成HTML jdoc,或者你可以使用他們的應用程序。 在您有適當的文檔后,您的方法順序不是一個問題。

我通常更喜歡選項2 - IDE中的類概述顯示公共和私有方法,自動完成僅顯示類的可見方法,但它確實不重要,正如@Visage所提到的那樣。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM