News for hackers. Stuff that matters.
Re:Ask HN: What developer tools would you like to see? by MivLives on Sunday May 22, 2022 @12:01PM (#31469577)
I want a tool that lets me annotate a codebase but with the notes stored locally and not in the code. This would mostly be for corporate code bases so I can take notes/ leave more explicit warnings for others.

Less "Turns markdown into react components" and more "If you have to touch this, you need to go to file x, add it there"

I understand this is imperfect but so is the codebase I work on.

Re:Ask HN: What developer tools would you like to see? by derrickpersson on Sunday May 22, 2022 @01:37PM (#31470703)
This is exactly what we're building at https://usecodex.com ! We've got an extension on the VS Code Marketplace if you'd like to check us out
Re:Ask HN: What developer tools would you like to see? by _boffin_ on Sunday May 22, 2022 @12:10PM (#31469674)
This isn't explicitly what you're asking for, but it's something: https://plugins.jetbrains.com/plugin/16998-notebook

I'm currently thinking of how to do exactly what you described with intellij plugin's. I've realized, that for me, i'm best when i print out code, use rulers to draw dividers between methods and other stuff, and then take notes for different parts of the code.

don't mind the horrid writing that's most likely unintelligible: https://i.ibb.co/ByTm7vt/notes.jpg

Re:Ask HN: What developer tools would you like to see? by Hackbraten on Sunday May 22, 2022 @03:19PM (#31471709)
> Less "Turns markdown into react components" and more "If you have to touch this, you need to go to file x, add it there"

I assume you’re being concerned specifically about the tone and style of your copy possibly coming across as maybe too casual and not professional enough. Please don’t be concerned.

A corporate environment doesn’t mean your inline or block comments need to be polished, bureaucratic, or conforming to some style policy. Whoever reads your code and comments is going to appreciate a helpful hint just like you and I would.

If I came across a block comment that told me the thing you mentioned, chances are I’d just feel grateful and appreciate the simple, no-bullshit guidance you afforded me.

Re:Ask HN: What developer tools would you like to see? by vmsp on Sunday May 22, 2022 @12:10PM (#31469672)
There's an Emacs mode that does this called annotate. But why would this be better than just leaving a comment on the file?

https://github.com/bastibe/annotate.el

Re:Ask HN: What developer tools would you like to see? by Frotag on Sunday May 22, 2022 @12:21PM (#31469810)
Personally I don't want to have to open the browser to get more detailed docs. I'd rather have it next to the code it's referencing. (Especially if it's just a side project where sphinx or whatever is overkill.)
Re:Ask HN: What developer tools would you like to see? by exdsq on Sunday May 22, 2022 @12:14PM (#31469723)
Maybe if you’re working on partially open source code you want a layer of comments separate to the code that aren’t version controlled so you can mention internal bits to each other?
Re:Ask HN: What developer tools would you like to see? by Frotag on Sunday May 22, 2022 @12:14PM (#31469718)
I've always wanted something similar to git blame for this. Where I can add notes to sets of lines and toggle whether I want the IDE to display them. Sort of like writing on those overhead projector sheets and saving it to a nearby .notes file or whatever. It'd probably be hell to maintain but a dev can dream.

Tangential, but it sucks that it's hard to even find discussion on something like this. Closest I've found is the fictional "an editor" talk here https://www.destroyallsoftware.com/talks/a-whole-new-world

Re:Ask HN: What developer tools would you like to see? by bsnnkv on Sunday May 22, 2022 @04:11PM (#31472260)
I have written an internal tool where I work that does this for our DevOps/Platform/Infrastructure repos. Basically, you annotate the code, and the annotation points you to somewhere easy to update (Confluence etc.) where you can add notes about the code.

Multiple files, repos etc can have the same reference, so when a CI pipeline runs for a PR on any repo, you get a nice PR comment showing you a tickbox-list of all the other places in the org where this reference exists for you to look at and to make sure you're not breaking something elsewhere, along with a link to wherever observations about this reference are written in prose.

Re:Ask HN: What developer tools would you like to see? by hellohowareu on Sunday May 22, 2022 @04:44PM (#31472558)
VS Code -> Line Note extension

https://github.com/tkrkt/linenote

Re:Ask HN: What developer tools would you like to see? by aitchnyu on Sunday May 22, 2022 @12:14PM (#31469719)
Aren't there tools that suggest, based on commit history "you edited x, and people who do edit y and z"?
Re:Ask HN: What developer tools would you like to see? by sebdufbeau on Sunday May 22, 2022 @12:20PM (#31469788)
Jetbrains IDEs have this feature, however I can't find any other documentation other than this StackOverflow question on how to disable the feature:

https://stackoverflow.com/questions/59105219/how-to-get-rid-...