@V4N4D1S Don't get me started on how it is 20 fucking 24 and we still can NOT, under ANY CIRCUMSTANCES, put a PICTURE in a code comment.
Because clearly no code has ever needed a DIAGRAM to explain it. That would be utterly useless. Besides, it's not like computers could handle it.
@WAHa_06x36 @V4N4D1S Markdown, github flavored, has it (if not markdown at all).
You can put a comment that direct to a section in a .md somewhere in your repo
@WAHa_06x36 @pixelpusher220 @OSchell well, it's damn useful that you can just cat and grep in code, and markdown is a pretty good compromise between machine and human readability.
there's several markdown extensions that can turn ascii art into diagrams. one of which is this one:
Precondition Sequence Diagrams Sequence Diagrams Options Flowcharts Mermaid Sequence Diagrams Flowcharts Gantt Charts Class Diagrams State Diagrams Pie Charts Requirement Diagram Gitgraph Diagrams / Commit Flow C4 Diagrams (plantUML compatible) Mindmap Timeline Quadrant Chart Sankey diagrams ZenUML XY Chart Global Mermaid Options Overview Diagram Alignment Mermaid Theme Auto Numbering Flowchart Curve Gantt Padding Inline Mermaid Config Save-as / Copy on Diagrams Precondition Typora supports some Markdown extensions for diagrams, to use this feature, first please enable Diagrams in Preferences Panel → Markdown section. When exporting as HTML, PDF, epub, docx, those rendered diagrams will also be included, but diagrams features...
@WAHa_06x36 @pixelpusher220 @OSchell You will stop me from editing the source file in a plain text editor by prying Notepad.exe/Notepad++.exe from my cold dead hands.
In the meantime, you can do Kanji Art if ASCII Art isn't your style.
@WAHa_06x36 @V4N4D1S eh, as I was told once, the only thing worse than no comments...is wrong comments.
Ppl can't reliably update plain text comments, they ain't editing pictures. Lol post about a link to a design seems like a decent middle ground
@pixelpusher220 By that argument we should just get rid of comments entirely. I am not going to accept an argument from mediocrity.
*I* can make and maintain pictures. And I need them form MYSELF.
@WAHa_06x36 @pixelpusher220 But can the person who's also working on your project work on the same diagram?
Or will they have to replicate it from scratch if they want to edit it, because it doesn't have layers?
That's what I like https://draw.io for.
Diagrams as vector or bitmap graphics that contain the actual diagram definition as Metadata and can be opened to make adjustments as code changes.
@WAHa_06x36 @V4N4D1S TempleOS supported this in its weird-ass C variant
so, just saying, this COULD have been solved, if only we'd listened
@WAHa_06x36 @V4N4D1S storing an image's data in source code would make it hard to edit with basic text edit.
So I guess it'd be like having a special syntax with a relative/absolute link inside a comment, and editors supporting this would render the image (possibly with an option to fold it down or zoom it) inside the comment sections.
Editing such a source with a non-supporting editor would show the special syntax with the link as plain text so one could still follow manually the link!
// please see the SVG file in main.c.1.svg for a diagram of the code you see below this comment
not enough?