Home > Back-end >  Comments and code separation is feasible?
Comments and code separation is feasible?

Time:01-03

A collaboration of the open source project, for example, it is hard to imagine that when the amount of comments & gt;=the amount of code, the entire file shows the layout of the ide become very chaotic,

Reading is greater than the number of open source developers, but amount of annotation code itself cannot meet different levels of readers, every reader has his notes to help understand the code, but not share these comments, it's serious human waste,

The same open source project, if we can every reader can share their comments, these comments like making the same area have start said heat value indicates the degree of the identity, sorted by heat reservation before 100, local can tag like comments as the default, eventually the reader's default comments can be saved to the local form a personalized and engineering,

Whether comments and code separation appears so to be necessary, Shared comments is much larger than the source code, can help to every one, the human will not be wasted,



Design says below, don't know vscode or idea have plug-ins can realize such functions,

The comments plugin function:

1 in different color, different levels of color piece annotation to the labeling of the code, can use a character or uml to annotation, uml can also be converted into character forms,
color piece code changes within the scope of this comment is marked as obsolete comment, will not be deleted, wait for the reader to change comment, unless there is no update, until after the top100 will delete (color piece of code shall not be less than x, not more than Y a comment, otherwise considered malicious comments )

2
Annotation will be separated before the code upload compressed into the root directory file, save the same comments top100 comments area, together with the code upload server
  • Related