比如一个多人协作的开源项目,很难想象当注释量>=代码量的时候,整个文件在ide的显示布局变得很混乱。
开源代码阅读的人数远大于开发人员,然而代码本身的注释量根本无法满足不同程度的阅读者。每个阅读者都有自己的注释来帮助理解代码,但是却无法共享这些注释,这可以说的严重的人力浪费。
同一个开源项目,如果能每个阅读者都能共享自己的注释,这些相同区域的注释像github一样有start表示热度值表示其受认同的程度,按热度排列保留前100,本地可以标记喜欢的注释为默认注释,最终阅读者的默认注释可以保存到本地形成一个个性化注释工程。
这么看来注释与代码分离显得是否有必要,共享的注释远远大于源码量,能帮助到每一个人,人力也不会被浪费。
下面说说设计,不知道vscode或者idea的插件有没有可以实现这样的功能。
注释插件功能:
1 以不同颜色,不同层次的色块来标注注释的代码范围。可以用字符或者uml来注释,UML也会被转换成字符形式。色块范围内代码改动则此注释被标记为过期注释,不会被删除,等待阅读者更改注释,除非没有人更新,直到top100之后将删除。(色块标注的代码不得少于x个,注释不得多于Y个,否则认为是恶意注释)
2
注释会在代码上传前被分离压缩为根目录文件,保存相同区域注释的top100的注释,随着代码一起上传服务器