| 摘要: | 在軟體開發過程中，程式開發者經常因為開發需求而遺漏或未更 新註解，導致程式碼與註解不一致。此外，隨著程式碼的頻繁變動， 因為註解具有時效性的問題，造成註解的歷史在最新版本的程式碼中 難以的完整被保留，然而這對未來的軟體維護至關重要。
傳統的程式碼註解方式存在諸多缺陷，例如無法留下長訊息、無 法支援多媒體註解，或是難以追蹤程式碼和註解的改動歷史等等的問 題。針對這些問題，本論文提出了一種名為 Message Box 的擴展自 GeekyNote 標籤系統工具，旨在通過自動化整合歷史訊息和結合 Git 訊息的方式，提供程式碼變更歷史追蹤和管理，以解決程式碼與註解 的一致性問題，並且能夠整合多種訊息以及儲存 HTML 標記、圖片、 影音等資料，使得訊息呈現更具可讀性。此外，Message Box 也透過 結合 Git 時間軸資料，補足註解的時效性問題，避免過去的訊息在最 新版本專案中消失。
Message Box 的設計和實現展示了一種新的程式碼與註解歷史變 動管理方式，有效提升了軟體開發的效率和程式碼的可維護性，減少 了註解與程式碼不一致與時效性的風險，提供了詳細的變更歷史記錄， 便於開發者進行追溯和理解。;In the software development process, developers often fail to update comments due to development needs, leading to inconsistencies between code and comments. Additionally, with frequent code changes, the temporal nature of comments causes the history of comments to be difficult to retain completely in the latest version of the code, which is crucial for future software maintenance.
Traditional code commenting methods have many drawbacks, such as the inability to leave long messages, lack of support for multimedia comments, and difficulty in tracking changes to code and comments. To address these issues, this thesis proposes a tool named Message Box, an extension of the GeekyNote tagging system, aimed at automatically integrating historical information and combining Git messages to provide code change history tracking and management. This tool resolves the consistency issues between code and comments, and can integrate various types of information as well as store HTML tags, images, videos, and other data, making the presentation of information more readable. Additionally, by incorporating Git timeline data, Message Box addresses the temporal nature of comments, preventing past information from disappearing in the latest project versions.
The design and implementation of Message Box demonstrate a new way to manage the historical changes of code and comments, significantly improving software development efficiency and code maintainability. It reduces the risk of inconsistencies and obsolescence of comments, provides detailed change history records, and facilitates developers in tracing and understanding changes. |
