Exploring AI-generated ASCII diagrams for code documentation, with examples from Claude and tips on rendering.
A software engineering article advocating for 'Question Driven Development' by asking critical questions before and after implementing features to ensure completeness.
TypeDoc's new {@includeCode} tag allows testing code examples in documentation by referencing specific regions from external test files.
Explains the critical role of good documentation in software development, highlighting its benefits for maintenance, onboarding, and knowledge transfer.
A guide to documenting Python code using docstrings, covering Numpy style formatting and best practices for function documentation.
Introducing Tutorial Markdown, an open-source JavaScript library that extends Markdown syntax to create interactive, self-coding tutorials for technical blogging.
An interview discussing the importance and ongoing debate around commenting code, challenging the 'comments are a failure' clean code perspective.
A passionate rant arguing for the importance of writing clear comments in code, even when the code itself is well-structured and 'self-documenting'.
Explains Java 8's new Javadoc tags @apiNote, @implSpec, and @implNote, covering their origin, usage, and integration with tools like Maven.
