主頁 > 軟體工程 > 在代碼中開始一個部分是否有注釋樣式?

在代碼中開始一個部分是否有注釋樣式?

2021-12-01 17:28:33 軟體工程

我指的是我在類中具有不同功能的情況,將其分解為較小的類是沒有意義的。

比如在Python中,我個人喜歡用

class DataStream:

  ################################
  # Read stream functionality
  ################################

  def read():
    pass

  def decode():
    pass

  ################################
  # Parse stream functionality
  ################################

  def exract_data():
    pass

  def map_data_types():
    pass

  ################################
  # Analyze functionality
  ################################

  def aggregated_data():
    pass

  def deduce_insights():
    pass
  

AFAIK,沒有關于此類評論的約定。

在 Java 中有這樣的約定嗎?或者任何 Intellij 可以從中制作出有用的東西的格式?例如,如果 Intellij 能夠折疊這些部分,那就太好了。

uj5u.com熱心網友回復:

與其依賴于在源代碼中將相關的函式方法分組并指示與代碼注釋的關系,不如以利用語言特性并使目的明確的方式設計和實作代碼。

例如,您可以使用不同的類來實作,而不是將烹飪方法和烘焙方法分組在同一個類中:

public class BakingOven{

    public Result bakeBread(){
    }

    public Result bakeCake(){
    }
}


public class FryingPan{

    public Result fryChicken(){
    }
    
    public Result frySteak(){
    }
}

這可以通過將要烘焙或油炸的內容作為引數傳遞來進一步實作,或者您可以識別常見的介面,如 Fry 或 Bake,并讓類實作這些介面。

這更多是一種設計,以及如何更清晰地構建代碼的問題型別,而不是將其視為檔案型別的問題。

uj5u.com熱心網友回復:

您的示例中存在一些基本問題。

class Kitchen:

  ################################
  # Getters/Setters
  ################################

  def get_groceries():
    pass

  ################################
  # Cooking Methods
  ################################

  def cook_chicken():
    pass

  def cook_pasta():
    pass

  ################################
  # Baking Methods
  ################################

  def bake_bread():
    pass

  def bake_cake():
    pass

首先Kitchen不要買雜貨。這意味著你的 Kitchen 在某些方面更像是一個資料結構,而不是一個物件;因為,您將雜貨暴露在廚房可能應該做的其他事情上。

其次,您正在創建復合方法,這樣您需要烹飪或烘焙的每個新專案都需要一種新方法。這是不好的命名實踐,因為這意味著如果Kitchen不重新編譯代碼就無法擴展。

    def cook( recipe ):

將是一個更好的設計,因為它可以采用任何食譜并進行烹飪。

最后,烘焙和烹飪是同一種轉化,它們都將原料轉化為可食用的成品。由于歷史和技術的原因,它們往往有不同的名稱;但是,烹飪一條面包是一種非常有效的表達烤面包的高級方式(就像將自己運送到商店是說步行到商店的一種完全有效的方式一樣)。

所以你的整體類設計可能應該是:

class Kitchen:

    def add( grocery )

    def use( grocery )

    def cook( recipe )

現在這個類更小,設計更好,可擴展且更易于除錯,為了完成圖片,讓我們實作雞肉、意大利面、面包和蛋糕的食譜:

interface Recipe:

   abstract def cook():

class ChickenRecipe implements Recipe:

   def cook(Kitchen kitchen):
       kitchen.use("chicken breast")
       kitchen.use("oil")
       kitchen.use("salt")
       kitchen.use("pepper")
       return "cooked chicken"

class PastaRecipe implements Recipe:

   def cook(Kitchen kitchen):
       kitchen.use("pasta")
       kitchen.use("water")
       kitchen.use("salt")
       kitchen.use("oil")
       return"cooked pasta"

class BreadRecipe implements Recipe:
    
   def cook(Kitchen kitchen):
       kitchen.use("flour")
       kitchen.use("water")
       kitchen.use("salt")
       kitchen.use("yeast")
       return "bread"

class CakeRecipe implments Recipe:

   def cook(Kitchen kitchen):
       kitchen.use("flour")
       kitchen.use("water")
       kitchen.use("salt")
       kitchen.use("sugar")
       kitchen.use("butter")
       return "cake"

現在,為了評估這種方法是否有用,讓我們問以下問題:

  • 您可以在看到廚房和任何特定食譜后實施另一個食譜嗎?
  • 您需要閱讀多少檔案才能制作新食譜?
  • 即使烹飪技術不屬于兩個類別(烹飪和烘焙),您是否可以添加新專案來烹飪?
  • 界面是否強迫您按照設計使用它?(與將所有物品從廚房中取出然后放入煮熟的物品相反)

如果你有一堆相關的方法,有時你不需要注釋來說明它們是相關的,你有一個介面,你沒有像介面那樣編碼。例如,你可以很容易地完成一個cook和一bake組方法,帶引數。雖然這可能更好地滿足英語的規則,但它實際上并沒有增加功能,而且它是一種不太有效的設計,因為您可以選擇使用錯誤的界面。

轉載請註明出處,本文鏈接:https://www.uj5u.com/gongcheng/370419.html

標籤:爪哇 智能理念 编码风格

上一篇:如何使用當前行(Intellij)創建自己的實時模板

下一篇:將復雜的設定從VSCode匯入GoLand

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • Git本地庫既關聯GitHub又關聯Gitee

    創建代碼倉庫 使用gitee舉例(github和gitee差不多) 1.在gitee右上角點擊+,選擇新建倉庫 ? 2.選擇填寫倉庫資訊,然后進行創建 ? 3.服務端已經準備好了,本地開始作準備 (1)Git 全域設定 git config --global user.name "成鈺" git c ......

    uj5u.com 2020-09-10 05:04:14 more
  • CODING DevOps 代碼質量實戰系列第二課,相約周三

    隨著 ToB(企業服務)的興起和 ToC(消費互聯網)產品進入成熟期,線上故障帶來的損失越來越大,代碼質量越來越重要,而「質量內建」正是 DevOps 核心理念之一。**《DevOps 代碼質量實戰(PHP 版)》**為 CODING DevOps 代碼質量實戰系列的第二課,同時也是本系列的 PHP ......

    uj5u.com 2020-09-10 05:07:43 more
  • 推薦Scrum書籍

    推薦Scrum書籍 直接上干貨,推薦書籍清單如下(推薦有順序的哦) Scrum指南 Scrum精髓 Scrum敏捷軟體開發 Scrum捷徑 硝煙中的Scrum和XP : 我們如何實施Scrum 敏捷軟體開發:Scrum實戰指南 Scrum要素 大規模Scrum:大規模敏捷組織的設計 用戶故事地圖 用 ......

    uj5u.com 2020-09-10 05:07:45 more
  • CODING DevOps 代碼質量實戰系列最后一課,周四發車

    隨著 ToB(企業服務)的興起和 ToC(消費互聯網)產品進入成熟期,線上故障帶來的損失越來越大,代碼質量越來越重要,而「質量內建」正是 DevOps 核心理念之一。 **《DevOps 代碼質量實戰(Java 版)》**為 CODING DevOps 代碼質量實戰系列的最后一課,同時也是本系列的 ......

    uj5u.com 2020-09-10 05:07:52 more
  • 敏捷軟體工程實踐書籍

    Scrum轉型想要做好,第一步先了解并真正落實Scrum,那么我推薦的Scrum書籍是要看懂并實踐的。第二步是團隊的工程實踐要做扎實。 下面推薦工程實踐書單: 重構:改善既有代碼的設計 決議極限編程 : 擁抱變化 代碼整潔代碼 程式員的職業素養 修改代碼的藝術 撰寫可讀代碼的藝術 測驗驅動開發 : ......

    uj5u.com 2020-09-10 05:07:55 more
  • Jenkins+svn+nginx實作windows環境自動部署vue前端專案

    前面文章介紹了Jenkins+svn+tomcat實作自動化部署,現在終于有空抽時間出來寫下Jenkins+svn+nginx實作自動部署vue前端專案。 jenkins的安裝和配置已經在前面文章進行介紹,下面介紹實作vue前端專案需要進行的哪些額外的步驟。 注意:在安裝jenkins和nginx的 ......

    uj5u.com 2020-09-10 05:08:49 more
  • CODING DevOps 微服務專案實戰系列第一課,明天等你

    CODING DevOps 微服務專案實戰系列第一課**《DevOps 微服務專案實戰:DevOps 初體驗》**將由 CODING DevOps 開發工程師 王寬老師 向大家介紹 DevOps 的基本理念,并探討為什么現代開發活動需要 DevOps,同時將以 eShopOnContainers 項 ......

    uj5u.com 2020-09-10 05:09:14 more
  • CODING DevOps 微服務專案實戰系列第二課來啦!

    近年來,工程專案的結構越來越復雜,需要接入合適的持續集成流水線形式,才能滿足更多變的需求,那么如何優雅地使用 CI 能力提升生產效率呢?CODING DevOps 微服務專案實戰系列第二課 《DevOps 微服務專案實戰:CI 進階用法》 將由 CODING DevOps 全堆疊工程師 何晨哲老師 向 ......

    uj5u.com 2020-09-10 05:09:33 more
  • CODING DevOps 微服務專案實戰系列最后一課,周四開講!

    隨著軟體工程越來越復雜化,如何在 Kubernetes 集群進行灰度發布成為了生產部署的”必修課“,而如何實作安全可控、自動化的灰度發布也成為了持續部署重點關注的問題。CODING DevOps 微服務專案實戰系列最后一課:**《DevOps 微服務專案實戰:基于 Nginx-ingress 的自動 ......

    uj5u.com 2020-09-10 05:10:00 more
  • CODING 儀表盤功能正式推出,實作作業資料可視化!

    CODING 儀表盤功能現已正式推出!該功能旨在用一張張統計卡片的形式,統計并展示使用 CODING 中所產生的資料。這意味著無需額外的設定,就可以收集歸納寶貴的作業資料并予之量化分析。這些海量的資料皆會以圖表或串列的方式躍然紙上,方便團隊成員隨時查看各專案的進度、狀態和指標,云端協作迎來真正意義上 ......

    uj5u.com 2020-09-10 05:11:01 more
最新发布
  • windows系統git使用ssh方式和gitee/github進行同步

    使用git來clone專案有兩種方式:HTTPS和SSH:
    HTTPS:不管是誰,拿到url隨便clone,但是在push的時候需要驗證用戶名和密碼;
    SSH:clone的專案你必須是擁有者或者管理員,而且需要在clone前添加SSH Key。SSH 在push的時候,是不需要輸入用戶名的,如果配置... ......

    uj5u.com 2023-04-19 08:41:12 more
  • windows系統git使用ssh方式和gitee/github進行同步

    使用git來clone專案有兩種方式:HTTPS和SSH:
    HTTPS:不管是誰,拿到url隨便clone,但是在push的時候需要驗證用戶名和密碼;
    SSH:clone的專案你必須是擁有者或者管理員,而且需要在clone前添加SSH Key。SSH 在push的時候,是不需要輸入用戶名的,如果配置... ......

    uj5u.com 2023-04-19 08:35:34 more
  • 2023年農牧行業6大CRM系統、5大場景盤點

    在物聯網、大資料、云計算、人工智能、自動化技術等現代資訊技術蓬勃發展與逐步成熟的背景下,數字化正成為農牧行業供給側結構性變革與高質量發展的核心驅動因素。因此,改造和提升傳統農牧業、開拓創新現代智慧農牧業,加快推進農牧業的現代化、資訊化、數字化建設已成為農牧業發展的重要方向。 當下,企業數字化轉型已經 ......

    uj5u.com 2023-04-18 08:05:44 more
  • 2023年農牧行業6大CRM系統、5大場景盤點

    在物聯網、大資料、云計算、人工智能、自動化技術等現代資訊技術蓬勃發展與逐步成熟的背景下,數字化正成為農牧行業供給側結構性變革與高質量發展的核心驅動因素。因此,改造和提升傳統農牧業、開拓創新現代智慧農牧業,加快推進農牧業的現代化、資訊化、數字化建設已成為農牧業發展的重要方向。 當下,企業數字化轉型已經 ......

    uj5u.com 2023-04-18 08:00:18 more
  • 計算機組成原理—存盤器

    計算機組成原理—硬體結構 二、存盤器 1.概述 存盤器是計算機系統中的記憶設備,用來存放程式和資料 1.1存盤器的層次結構 快取-主存層次主要解決CPU和主存速度不匹配的問題,速度接近快取 主存-輔存層次主要解決存盤系統的容量問題,容量接近與價位接近于主存 2.主存盤器 2.1概述 主存與CPU的聯 ......

    uj5u.com 2023-04-17 08:20:31 more
  • 談一談我對協同開發的一些認識

    如今各互聯網公司普通都使用敏捷開發,采用小步快跑的形式來進行專案開發。如果是小專案或者小需求,那一個開發可能就搞定了。但對于電商等復雜的系統,其功能多,結構復雜,一個人肯定是搞不定的,所以都是很多人來共同開發維護。以我曾經待過的商城團隊為例,光是后端開發就有七十多人。 為了更好地開發這類大型系統,往 ......

    uj5u.com 2023-04-17 08:18:55 more
  • 專案管理PRINCE2核心知識點整理

    PRINCE2,即 PRoject IN Controlled Environment(受控環境中的專案)是一種結構化的專案管理方法論,由英國政府內閣商務部(OGC)推出,是英國專案管理標準。
    PRINCE2 作為一種開放的方法論,是一套結構化的專案管理流程,描述了如何以一種邏輯性的、有組織的方法,... ......

    uj5u.com 2023-04-17 08:18:51 more
  • 談一談我對協同開發的一些認識

    如今各互聯網公司普通都使用敏捷開發,采用小步快跑的形式來進行專案開發。如果是小專案或者小需求,那一個開發可能就搞定了。但對于電商等復雜的系統,其功能多,結構復雜,一個人肯定是搞不定的,所以都是很多人來共同開發維護。以我曾經待過的商城團隊為例,光是后端開發就有七十多人。 為了更好地開發這類大型系統,往 ......

    uj5u.com 2023-04-17 08:18:00 more
  • 專案管理PRINCE2核心知識點整理

    PRINCE2,即 PRoject IN Controlled Environment(受控環境中的專案)是一種結構化的專案管理方法論,由英國政府內閣商務部(OGC)推出,是英國專案管理標準。
    PRINCE2 作為一種開放的方法論,是一套結構化的專案管理流程,描述了如何以一種邏輯性的、有組織的方法,... ......

    uj5u.com 2023-04-17 08:17:55 more
  • 計算機組成原理—存盤器

    計算機組成原理—硬體結構 二、存盤器 1.概述 存盤器是計算機系統中的記憶設備,用來存放程式和資料 1.1存盤器的層次結構 快取-主存層次主要解決CPU和主存速度不匹配的問題,速度接近快取 主存-輔存層次主要解決存盤系統的容量問題,容量接近與價位接近于主存 2.主存盤器 2.1概述 主存與CPU的聯 ......

    uj5u.com 2023-04-17 08:12:06 more