比如一個多人協作的開源專案,很難想象當注釋量>=代碼量的時候,整個檔案在ide的顯示布局變得很混亂。
開源代碼閱讀的人數遠大于開發人員,然而代碼本身的注釋量根本無法滿足不同程度的閱讀者。每個閱讀者都有自己的注釋來幫助理解代碼,但是卻無法共享這些注釋,這可以說的嚴重的人力浪費。
同一個開源專案,如果能每個閱讀者都能共享自己的注釋,這些相同區域的注釋像github一樣有start表示熱度值表示其受認同的程度,按熱度排列保留前100,本地可以標記喜歡的注釋為默認注釋,最終閱讀者的默認注釋可以保存到本地形成一個個性化注釋工程。
這么看來注釋與代碼分離顯得是否有必要,共享的注釋遠遠大于原始碼量,能幫助到每一個人,人力也不會被浪費。
下面說說設計,不知道vscode或者idea的插件有沒有可以實作這樣的功能。
注釋插件功能:
1 以不同顏色,不同層次的色塊來標注注釋的代碼范圍。可以用字符或者uml來注釋,UML也會被轉換成字符形式。
色塊范圍內代碼改動則此注釋被標記為過期注釋,不會被洗掉,等待閱讀者更改注釋,除非沒有人更新,直到top100之后將洗掉。(色塊標注的代碼不得少于x個,注釋不得多于Y個,否則認為是惡意注釋)
2
注釋會在代碼上傳前被分離壓縮為根目錄檔案,保存相同區域注釋的top100的注釋,隨著代碼一起上傳服務器
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/243672.html
標籤:Web 開發
上一篇:有大佬嗎,給個答案
