17 Repos
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 ist eine VSCode-Erweiterung, die dazu entwickelt wurde, automatisch standardisierte Kommentarblöcke am Anfang von Quelldateien zu generieren und zu aktualisieren. Sie dient als Dateimetadaten-Manager und automatischer Code-Dokumentierer, der Urheberschaft, Änderungszeiten und Dateipfade beim Speichern direkt im Code nachverfolgt. Das Tool synchronisiert Autorennamen und E-Mail-Adressen aus lokalen Git-Konfigurationen, um Header-Felder zu befüllen. Es verfügt zudem über einen Quellcode-Kommentar-Dekorateur, der in der Lage ist, dekorative Kommentar-Art und visuelle Muster einzufügen, um Code-Abschnitte zu organisieren. Die Erweiterung deckt ein breites Spektrum an Funktionen ab, einschließlich der automatischen Generierung von Funktions-Docstrings durch Parameterextraktion, vorlagenbasierter Anpassung für Urheberrechtshinweise und Lizenzen sowie sprachspezifischer Trennzeichenzuordnung. Sie enthält Filtermechanismen, um bestimmte Verzeichnisse oder Dateiendungen auszuschließen, und verwendet Änderungsdetektion, um triviale Metadaten-Updates rückgängig zu machen und so redundante Versionskontroll-Commits zu verhindern.
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.
This project is a comprehensive collection of Python programming education materials, including tutorials, exercises, and curated code samples. It serves as a learning curriculum and software engineering toolkit, utilizing Jupyter Notebooks to combine executable code with descriptive educational text. The repository provides practical implementation guides for building large language model applications, such as retrieval-augmented generation systems, stateful AI agents, and machine learning workflows. It distinguishes itself by offering a structured approach to agentic coding workflows, cover
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 ist ein Data-Science-Lehrplan und eine Bildungsressource, die für die Beherrschung der Programmiersprache R entwickelt wurde. Es bietet einen strukturierten Lernpfad für den End-to-End-Prozess des Importierens, Bereinigens, Transformierens und Visualisierens von Daten. Das Projekt betont einen Leitfaden für reproduzierbare Data Science und einen umfassenden Lehrplan für Data Wrangling. Es enthält spezialisierte Tutorials zur Grammatik der Grafik für geschichtete Datenvisualisierung sowie technische Publikationen, die mit Quarto erstellt wurden und ausführbaren Code mit erzählendem Text verbinden. Das Material deckt ein breites Spektrum analytischer Funktionen ab, einschließlich Datenaufnahme aus diversen Quellen, relationalem Daten-Joining und der Verwaltung kategorialer Variablen. Es behandelt zudem Datenbereinigung, mathematische Modellierung und die Erstellung professioneller Berichte und Präsentationen in verschiedenen Formaten. Der Lehrplan konzentriert sich auf die praktische Anwendung funktionaler Programmierung und Tidy-Data-Prinzipien, um transparente und wiederholbare Analysen zu erstellen.
Teaches how to annotate code logic with human-readable text for better developer understanding.
Nerdcommenter ist ein Vim-Kommentierungs-Plugin und Textmanipulator, der entwickelt wurde, um das Einfügen, Entfernen und Formatieren sprachspezifischer Code-Kommentare zu automatisieren. Es dient als Dienstprogramm zum Umschalten von Kommentar-Markern und zum Ausrichten von Kommentarblöcken, um die Code-Organisation zu verbessern. Das Tool bietet Funktionen zum Umschalten des Kommentarstatus und zum Wechseln von Trennzeichen, wodurch Benutzer Marker aus einzelnen Zeilen oder ausgewählten Textblöcken hinzufügen oder entfernen können. Es enthält Funktionen zur Formatierung von Kommentarblöcken, um visuelle Konsistenz zu gewährleisten, sowie die Möglichkeit, Code auszukommentieren, um die Ausführung zu deaktivieren. Das Plugin deckt ein breites Spektrum funktionaler Anwendungen ab, einschließlich Quellcode-Dokumentation und Code-Logik-Debugging. Es optimiert den Vim-Workflow, indem es die Anzahl der Tastenanschläge reduziert, die zur Verwaltung von Kommentar-Trennzeichen in verschiedenen Programmiersprachen erforderlich sind.
Facilitates the creation of clean, readable documentation blocks within the source code.
TSDoc ist ein Dokumentationsstandard und eine Spezifikation für das Schreiben strukturierter Kommentare in TypeScript-Code. Es bietet ein portables System zur Definition von Metadaten, Tags und Querverweisen innerhalb des Quellcodes, um eine konsistente Analyse und Darstellung über verschiedene Toolings hinweg zu gewährleisten. Das Projekt enthält einen Doc-Kommentar-Parser, der Kommentare in einen strukturierten Syntaxbaum umwandelt, sowie einen Validator, der die Syntaxkonsistenz erzwingt. Es ermöglicht die Definition benutzerdefinierter Dokumentations-Tags über externe Konfigurationsdateien und unterstützt mehrere Syntax-Validierungsmodi, um die Einhaltung der Spezifikation zu unterstützen. Die Spezifikation deckt eine breite Palette von API-Dokumentationsanforderungen ab, einschließlich der Kennzeichnung von Release-Stufen, Stabilität und Deprecation. Sie unterstützt die Detaillierung von Funktionsparametern, Rückgabewerten und Exception-Typen sowie die Verwaltung von interner Sichtbarkeit, Vererbung und Querverweisen zwischen Deklarationen.
Establishes a standardized way to write documentation comments for TypeScript code across different tools.
Textract ist ein Tool und Parser zur Textextraktion aus verschiedenen Formaten. Es bietet eine einheitliche Schnittstelle, um Klartext aus einer Vielzahl von Quellen zu extrahieren, einschließlich Dokumenten, Bildern und Audiodateien. Das System fungiert als Dokumenten-Content-Parser für PDFs und Tabellenkalkulationen, als Bildtextextraktor mittels optischer Zeichenerkennung (OCR) und als Speech-to-Text-Transkribierer für Audioaufnahmen.
Maps PDFs and spreadsheets to a common internal representation for consistent text retrieval.
Dieses Projekt ist eine Sammlung technischer Analysen und annotierter Quellcodes, die eine detaillierte Untersuchung der Underscore JavaScript-Utility-Bibliothek bieten. Es dient als Quellcode-Dokumentation, die High-Level-Funktionslogik durch technische Kommentare spezifischen Codezeilen zuordnet. Die Analyse konzentriert sich auf das Studium von JavaScript-Mustern und die Dokumentation von Legacy-Code. Sie untersucht historische Sprachbeschränkungen und Strategien zur Browserkompatibilität, um die Entwicklung von Utility-Mustern und die Beweggründe hinter spezifischen architektonischen Entscheidungen in älteren Bibliotheksversionen zu erklären. Das Projekt deckt mehrere technische Bereiche ab, einschließlich der Zerlegung monolithischer Bibliotheken in modulare Artikel, das Studium wiederverwendbarer Codierungsmuster für Utility-Funktionen und die Partitionierung von Quellcode in funktionale Kategorien.
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.