3 ms·

> annotations - not just "comments" What kind of annotations would not make sense as comments?

by qznc 10y ago

wingerlang 10y ago
Discussions about the code perhaps.
Juliate 10y ago
Annotations as what you scribble in the margin of an article or on a page in a book. Comments are inline with the code. Annotations are aside, and serve both as visual anchors and as "aside" notes.
- robinshen 10y ago
  Is it something like this? http://gitplex.pmease.com/demo/android-framework-base/files?revision=master&path=core/java/android/inputmethodservice/Keyboard.java&mark=138.4-146.48&comment=2 http://gitplex.pmease.com/demo/android-framework-base/files?... You may also put annotations on any diffs: http://gitplex.pmease.com/demo/android-framework-base/commit?revision=72d6dca09e85627b47c94f9a6ebf37ea56291450&comment=3&mark=72d6dca09e85627b47c94f9a6ebf37ea56291450:wifi/java/android/net/wifi/p2p/WifiP2pManager.java:286.4-289.7 http://gitplex.pmease.com/demo/android-framework-base/commit...
TeMPOraL 10y ago
I'm thinking in terms of what I'd do if the code was printed out on paper. http://imgur.com/KMCBMjA http://imgur.com/KMCBMjA
- oneeyedpigeon 10y ago
  The trouble with that is, how on earth do you get the annotations to apply across revisions? Or would you be OK with them only applying to a given revision and then ... what, disappearing? Or going into a 'floating bucket' of annotations for the entire file?
  - TeMPOraL 10y ago
    I'd be fine with them sticking to particular lines of code[0] and disappearing if those lines were changed. This is not something I'd like to commit into codebase, it's for exploration / preparing work. -- [0] - "smart stick" can be implemented by remembering not just the line in file, but also the contents of that line and a (fuzzy) context.
    - oneeyedpigeon 10y ago
      Interesting. In these terms, it could probably just be a totally separate, general-purpose 'text file annotation' tool with git support (but not a requirement).
    - leonya2 10y ago
      Upsource has sticky comments that survive code changes well.
    - robinshen 10y ago
      Sticky comment is actually another form of git blame, and will be available in future versions of GitPlex.

> annotations - not just "comments" What kind of annotations would not make sense as comments?

by qznc 10y ago

> annotations - not just "comments" What kind of annotations would not make sense as comments?

wingerlang 10y ago

Discussions about the code perhaps.

Juliate 10y ago

Annotations as what you scribble in the margin of an article or on a page in a book. Comments are inline with the code. Annotations are aside, and serve both as visual anchors and as "aside" notes.

robinshen 10y ago
Is it something like this? http://gitplex.pmease.com/demo/android-framework-base/files?revision=master&path=core/java/android/inputmethodservice/Keyboard.java&mark=138.4-146.48&comment=2 http://gitplex.pmease.com/demo/android-framework-base/files?... You may also put annotations on any diffs: http://gitplex.pmease.com/demo/android-framework-base/commit?revision=72d6dca09e85627b47c94f9a6ebf37ea56291450&comment=3&mark=72d6dca09e85627b47c94f9a6ebf37ea56291450:wifi/java/android/net/wifi/p2p/WifiP2pManager.java:286.4-289.7 http://gitplex.pmease.com/demo/android-framework-base/commit...

TeMPOraL 10y ago

I'm thinking in terms of what I'd do if the code was printed out on paper. http://imgur.com/KMCBMjA http://imgur.com/KMCBMjA

oneeyedpigeon 10y ago
The trouble with that is, how on earth do you get the annotations to apply across revisions? Or would you be OK with them only applying to a given revision and then ... what, disappearing? Or going into a 'floating bucket' of annotations for the entire file?
- TeMPOraL 10y ago
  I'd be fine with them sticking to particular lines of code[0] and disappearing if those lines were changed. This is not something I'd like to commit into codebase, it's for exploration / preparing work. -- [0] - "smart stick" can be implemented by remembering not just the line in file, but also the contents of that line and a (fuzzy) context.
  - oneeyedpigeon 10y ago
    Interesting. In these terms, it could probably just be a totally separate, general-purpose 'text file annotation' tool with git support (but not a requirement).
  - leonya2 10y ago
    Upsource has sticky comments that survive code changes well.
  - robinshen 10y ago
    Sticky comment is actually another form of git blame, and will be available in future versions of GitPlex.