架構決策記錄:程式設計程式碼編輯器

背景

程式設計程式碼編輯器是開發人員編寫和編輯程式碼的必備工具。市面上有眾多程式碼編輯器,各有其功能、優點和缺點。本 ADR 的目的是記錄針對程式設計程式碼編輯器所做的架構決策。

優先事項

程式設計程式碼編輯器的架構應優先考慮以下幾點:

• 模組化:程式碼編輯器應以模組化的方式設計,使開發人員能夠根據需要對其進行定製和擴充套件。這樣可以形成靈活的架構,適應不同開發人員和團隊的需求。

• 效能:程式碼編輯器應當高效能且響應迅速,使開發人員能夠高效工作,而不會被所用的工具拖慢。

• 使用者介面:使用者介面應當直觀易用,使開發人員能夠專注於程式碼,而不必與編輯器較勁。

• 可擴充套件性:程式碼編輯器的設計應便於透過第三方外掛和整合進行擴充套件。

• 相容性:程式碼編輯器應相容多種程式語言和技術,使其成為適合廣大開發人員的實用工具。

決策

基於這些優先事項,程式設計程式碼編輯器的架構應設計為包含以下元件:

• 核心:該元件提供程式碼編輯器的基本功能,例如語法高亮、文字編輯和檔案管理。

• UI:該元件提供程式碼編輯器的使用者介面,包括選單、工具欄和鍵盤快捷鍵。

• 外掛:該元件允許開發人員透過安裝第三方外掛來擴充套件程式碼編輯器的功能。外掛可以提供額外的功能,例如程式碼補全、程式碼檢查(lint)或除錯。

• 整合:該元件允許程式碼編輯器與其他工具和技術整合,例如版本控制系統、構建系統或除錯工具。

理由

程式碼編輯器的模組化使開發人員能夠根據需要對其進行定製和擴充套件。這一點很重要,因為不同的開發人員和團隊有不同的需求和工作流程,靈活的架構可以適應這些差異。

• 效能:至關重要,因為開發人員需要能夠高效工作,而不會被工具拖慢。高效能的程式碼編輯器對生產率至關重要,並有助於開發人員保持專注。

• UI:很重要,因為它使開發人員能夠專注於程式碼,而不必與編輯器較勁。這可以帶來更高的生產率,並減少開發人員的挫敗感。

• 可擴充套件性:很強大,因為它使程式碼編輯器能夠適應不同的需求和工作流程。第三方外掛和整合可以提供核心編輯器所不具備的額外特性和能力。

• 相容性:很有價值,因為它使程式碼編輯器能夠用於多種程式語言和技術。這使該編輯器成為適合廣大開發人員的更實用的工具。

核心、外掛、整合和 UI 元件實現了清晰的關注點分離,形成了易於擴充套件和定製的模組化架構。這種架構靈活、高效能,併相容多種程式語言和技術,使其成為對開發人員有用的工具。