17 repositorios
Annotates logic with human-readable text that is ignored by the compiler but preserved for developers.
Distinguishing note: None of the candidates relate to language-level documentation comments.
Explore 17 awesome GitHub repositories matching programming languages & runtimes · Source Code Documentation. Refine with filters or upvote what's useful.
Crystal is a statically typed, compiled programming language designed for high performance and memory safety. It leverages an LLVM-based compiler to translate source code into optimized machine-executable binaries, while its type-inference-based static analysis enforces strict safety rules during the build process. The language distinguishes itself through a fiber-based concurrent runtime that manages lightweight execution units for asynchronous input and output without blocking the main process. It also features a powerful compile-time macro system that allows for the inspection and transfor
Preserves developer-focused documentation within the source code.
This project is an educational resource designed for learning the Python programming language. It serves as a tutorial repository and programming guide, providing a collection of annotated scripts, code examples, and cheatsheets to help users master syntax and core fundamentals. The resource focuses on moving from basic language syntax to advanced implementation, with a particular emphasis on object-oriented programming, the use of the Python standard library, and scripting automation for business workflows. The content covers a broad range of programming capabilities, including control flow
Shows how to use single-line comments and docstrings to provide internal documentation within source files.
The Rust Programming Language Book is the official technical guide and educational resource for the Rust language. It provides a comprehensive walkthrough of the language's design, focusing on its core identity as a systems programming language that enforces memory safety and high-performance execution without the need for a garbage collector. The project is distinguished by its focus on ownership, borrowing, and lifetime tracking, which allow the compiler to verify memory safety and thread safety at compile time. It covers the language's unique approach to zero-cost abstractions, including t
Supports human-readable documentation comments ignored by the compiler.
Showdoc is a technical documentation platform and knowledge management system designed to centralize project specifications, internal manuals, and technical guides. Built as a PHP web application, it provides a collaborative environment for teams to organize and share information across software development organizations. The platform distinguishes itself through its ability to automate documentation workflows by parsing source code comments and synchronizing technical records with the current state of a codebase. It also features specialized tools for managing RESTful API documentation and g
The system scans source code files for specific comment patterns to extract and synchronize technical documentation with the codebase.
This repository is a collection of solved algorithmic problems and data structure exercises designed for technical interview preparation. It serves as a polyglot reference implementation, providing a set of solved exercises based on a standard textbook to help candidates master the logic and complexity analysis required for coding tests. The project implements the same algorithmic logic across multiple programming languages to demonstrate platform-independent problem solving. This polyglot approach allows for the comparison of implementations across different tech stacks to highlight recurrin
Embeds algorithmic complexity and logic explanations directly within the source code comments.
A fast, helpful, and open-source document parser
An open-source document parser that extracts text, tables, and layout from PDFs and office files into Markdown or JSON.
TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support
Transforms source code into searchable documentation by analyzing entry points and compiler settings.
koro1FileHeader es una extensión de VSCode diseñada para generar y actualizar automáticamente bloques de comentarios estandarizados en la parte superior de los archivos fuente. Sirve como gestor de metadatos de archivos y documentador de código automatizado que rastrea la autoría, los tiempos de modificación y las rutas de archivo directamente dentro del código al guardar. La herramienta sincroniza los nombres de autor y direcciones de correo electrónico de las configuraciones locales de Git para completar los campos de encabezado. También cuenta con un decorador de comentarios de código fuente capaz de insertar arte de comentarios decorativos y patrones visuales para organizar secciones de código. La extensión cubre una amplia gama de capacidades, incluyendo la generación automática de docstrings de funciones mediante la extracción de parámetros, personalización basada en plantillas para avisos de copyright y licencias, y mapeo de delimitadores específico del lenguaje. Incluye mecanismos de filtrado para excluir directorios o extensiones de archivo específicos y emplea detección de cambios para revertir actualizaciones de metadatos triviales, evitando commits de control de versiones redundantes.
Automatically generates and updates standardized file headers and function comments to maintain consistent documentation across a codebase.
Documentation.js is a multi-purpose documentation tool that parses JSDoc annotations from JavaScript and TypeScript source files to generate formatted API documentation. It functions as both a documentation generator and a JSDoc linter, scanning source code for non-standard or incorrect annotations and returning human-readable warnings to enforce documentation quality. The tool operates through a pipeline-based architecture that parses JSDoc comments into an abstract syntax tree, validates annotations against style and correctness rules, and outputs documentation through interchangeable plugi
Generates documentation from TypeScript source files by parsing JSDoc annotations.
Este proyecto es una colección completa de materiales educativos de programación en Python, incluyendo tutoriales, ejercicios y muestras de código curadas. Sirve como un plan de estudios de aprendizaje y kit de herramientas de ingeniería de software, utilizando Jupyter Notebooks para combinar código ejecutable con texto educativo descriptivo. El repositorio proporciona guías de implementación prácticas para construir aplicaciones de modelos de lenguaje grandes, como sistemas de generación aumentada por recuperación, agentes de IA con estado y flujos de trabajo de aprendizaje automático. Se distingue por ofrecer un enfoque estructurado para flujos de trabajo de codificación agentica, cubriendo destilación de ventana de contexto, enrutamiento de modelos agnóstico al proveedor y salidas estructuradas forzadas por esquema. Los materiales cubren una amplia gama de capacidades de ingeniería de software, incluyendo programación asíncrona con colas de tareas distribuidas, desarrollo de aplicaciones web con API REST y flujos de trabajo de análisis de datos. También incluye recursos para dominar el diseño orientado a objetos, implementar tuberías de CI/CD y aplicar estándares profesionales de linting y formato.
Teaches how to annotate logic with docstrings and comments to improve code readability.
c3c is the compiler for the C3 programming language, transforming source code into executable binaries, static libraries, or dynamic libraries using an LLVM backend. It implements a system based on result-based error handling, scoped memory pooling, and a semantic macro system. The compiler provides first-class support for hardware-backed SIMD vectors that map directly to processor instructions and enables runtime polymorphism through interface-based dynamic dispatch. The project covers a broad set of low-level capabilities, including manual and pooled memory management, inline assembly inte
Embeds descriptive text and formal contracts directly into the source code using special delimiters.
r4ds es un currículo de ciencia de datos y recurso educativo diseñado para dominar el lenguaje de programación R. Proporciona una ruta de aprendizaje estructurada para el proceso de extremo a extremo de importar, limpiar, transformar y visualizar datos. El proyecto enfatiza una guía de ciencia de datos reproducible y un currículo integral para la manipulación de datos (data wrangling). Incluye tutoriales especializados sobre la gramática de gráficos para la visualización de datos en capas y publicaciones técnicas creadas con Quarto que combinan código ejecutable con prosa narrativa. El material cubre una amplia gama de capacidades analíticas, incluyendo la ingesta de datos de diversas fuentes, unión de datos relacionales y la gestión de variables categóricas. También aborda la limpieza de datos, modelado matemático y la generación de informes y presentaciones profesionales en múltiples formatos. El currículo se centra en la aplicación práctica de la programación funcional y los principios de datos ordenados (tidy data) para crear análisis transparentes y repetibles.
Teaches how to annotate code logic with human-readable text for better developer understanding.
Nerdcommenter es un plugin de comentarios para Vim y manipulador de texto diseñado para automatizar la inserción, eliminación y formateo de comentarios de código específicos de cada lenguaje. Sirve como utilidad para alternar marcadores de comentarios y alinear bloques de comentarios para mejorar la organización del código. La herramienta proporciona capacidades para alternar el estado de los comentarios y cambiar delimitadores, permitiendo a los usuarios añadir o eliminar marcadores de líneas individuales o bloques de texto seleccionados. Incluye características para el formateo de bloques de comentarios para garantizar la consistencia visual y la capacidad de comentar código para deshabilitar su ejecución. El plugin cubre una amplia gama de aplicaciones funcionales, incluyendo la documentación de código fuente y la depuración de lógica de código. Optimiza el flujo de trabajo en Vim al reducir las pulsaciones de teclas necesarias para gestionar los delimitadores de comentarios en varios lenguajes de programación.
Facilitates the creation of clean, readable documentation blocks within the source code.
TSDoc es un estándar de documentación y especificación para escribir comentarios estructurados en código TypeScript. Proporciona un sistema portátil para definir metadatos, etiquetas y referencias cruzadas dentro del código fuente para garantizar un análisis y renderizado consistentes en diferentes herramientas. El proyecto incluye un analizador de comentarios de documentación que convierte los comentarios en un árbol de sintaxis estructurado y un validador que aplica la consistencia de la sintaxis. Permite la definición de etiquetas de documentación personalizadas a través de archivos de configuración externos y admite múltiples modos de validación de sintaxis para ayudar con el cumplimiento de la especificación. La especificación cubre una amplia gama de necesidades de documentación de API, incluyendo el marcado de etapas de lanzamiento, estabilidad y obsolescencia. Admite detallar parámetros de funciones, valores de retorno y tipos de excepciones, así como gestionar la visibilidad interna, la herencia y las referencias cruzadas entre declaraciones.
Establishes a standardized way to write documentation comments for TypeScript code across different tools.
Textract is a multi-format text extraction tool and parser. It provides a unified interface to extract plain text from a variety of sources, including documents, images, and audio files. The system functions as a document content parser for PDFs and spreadsheets, an image text extractor using optical character recognition, and a speech-to-text transcriber for audio recordings.
Maps PDFs and spreadsheets to a common internal representation for consistent text retrieval.
This project is a collection of technical breakdowns and annotated source code providing a detailed analysis of the Underscore JavaScript utility library. It serves as source code documentation that maps high-level functional logic to specific lines of code through technical commentary. The analysis focuses on JavaScript pattern study and legacy code documentation. It examines historical language constraints and browser compatibility strategies to explain the evolution of utility patterns and the reasoning behind specific architectural choices in older library versions. The project covers se
Maps high-level functional logic to specific lines of code through detailed technical commentary and modular breakdowns.
Tinymist is a comprehensive suite of tools for Typst document authoring, serving as a language server, document compiler, and project manager. It provides a standardized language service via the Language Server Protocol to enable editor features such as autocompletion, navigation, and semantic highlighting. The project distinguishes itself by integrating a TCP-based live preview server for real-time visual rendering and an advanced static analysis tool that utilizes abstract syntax trees and bidirectional type checking. It also includes a project management system capable of handling multi-fi
Extracts human-readable descriptions and type annotations from source comments for hover display.