3 ms·
Ask HN: Looking for a code book to log my comments, code snippets, etc.
Hello,
I'm looking for an app that will allow me to write some sort of log that can contain code snippets, explanations, comments. That will keep it all organized and has code syntax.
Basically I'm tasked to break down a lot of code from VB6. I want a place I can add my code snippets for sql, maybe pseudo code and anything else I might need to add.
Maybe break the log up into potential function names.
Thanks for the help.
- WalterGR 4y agoMarkdown?
- thedangler 4y agoI guess it could be markdown but looking for more organization as this will be a rather large project of organizing the code for example I could should the old code. Strip out any sql and place that into another block explaining what it does. Have an explanation for the overall old function. Then how to make it better. Other would probably be reading this too.
- WalterGR 4y agoWhy not comments in the code? Open issues in a tracker for things to improve? Have a look at “literate programming” and available tools for the concept.
- thedangler 4y agoI'm going through roughly 100 old vb6 functions that do god knows what and breaking them down into knew SQL queries ( we are restructuring the entire database, last one had no PK, FK, or normalization) I'm writing what I think the functions do and documenting what new tables should be used. I also will be rewriting some of them but for now I'm doing this so when more team members join the project then can have the coles notes on each vb6 code breakdown. Thanks for the suggestions.
- thedangler 4y agoLooks like I found some like quiver or cherrytree. Work is windows so quiver is out.
- linsomniac 4y agoWhat about Jupyter Notebooks? If you are including code, that seems like a useful platform. https://jupyter.org/ https://jupyter.org/