17 repository-uri
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 is a VSCode extension designed to automatically generate and update standardized comment blocks at the top of source files. It serves as a file metadata manager and automated code documenter that tracks authorship, modification times, and file paths directly within the code upon saving. The tool synchronizes author names and email addresses from local Git configurations to populate header fields. It also features a source code comment decorator capable of inserting decorative comment art and visual patterns to organize code sections. The extension covers a broad range of capa
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.
Acest proiect este o colecție cuprinzătoare de materiale educaționale de programare Python, incluzând tutoriale, exerciții și mostre de cod curate. Acesta servește drept curriculum de învățare și set de instrumente de inginerie software, utilizând Jupyter Notebooks pentru a combina codul executabil cu text educațional descriptiv. Repository-ul oferă ghiduri practice de implementare pentru construirea de aplicații cu modele de limbaj mari, cum ar fi sisteme de generare augmentată prin regăsire (RAG), agenți AI cu stare și fluxuri de lucru de machine learning. Se distinge prin oferirea unei abordări structurate a fluxurilor de lucru de codare agentică, acoperind distilarea ferestrei de context, rutarea modelelor agnostice la furnizor și output-uri structurate impuse prin schemă. Materialele acoperă o gamă largă de capabilități de inginerie software, inclusiv programarea asincronă cu cozi de sarcini distribuite, dezvoltarea de aplicații web cu API-uri REST și fluxuri de lucru de analiză a datelor. Include, de asemenea, resurse pentru stăpânirea designului orientat pe obiecte, implementarea pipeline-urilor CI/CD și aplicarea standardelor profesionale de linting și formatare.
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 este un curriculum de știința datelor și o resursă educațională concepută pentru stăpânirea limbajului de programare R. Oferă o cale de învățare structurată pentru procesul end-to-end de importare, curățare, transformare și vizualizare a datelor. Proiectul pune accent pe un ghid de știința datelor reproductibil și un curriculum cuprinzător pentru manipularea datelor (data wrangling). Include tutoriale specializate despre gramatica graficelor pentru vizualizarea stratificată a datelor și publicații tehnice create cu Quarto care îmbină codul executabil cu proza narativă. Materialul acoperă o gamă largă de capabilități analitice, inclusiv ingestia de date din surse diverse, unirea datelor relaționale și gestionarea variabilelor categorice. De asemenea, abordează curățarea datelor, modelarea matematică și generarea de rapoarte și prezentări profesionale în formate multiple. Curriculum-ul se concentrează pe aplicarea practică a programării funcționale și a principiilor „tidy data” pentru a crea analize transparente și repetabile.
Teaches how to annotate code logic with human-readable text for better developer understanding.
Nerdcommenter este un plugin de comentare pentru Vim și un manipulator de text conceput pentru a automatiza inserarea, eliminarea și formatarea comentariilor de cod specifice limbajului. Servește drept utilitar pentru comutarea markerelor de comentariu și alinierea blocurilor de comentarii pentru a îmbunătăți organizarea codului. Instrumentul oferă capabilități pentru comutarea stării comentariilor și schimbarea delimitatorilor, permițând utilizatorilor să adauge sau să elimine markere de pe linii individuale sau blocuri de text selectate. Include funcții pentru formatarea blocurilor de comentarii pentru a asigura consistența vizuală și capacitatea de a comenta codul pentru a dezactiva execuția. Plugin-ul acoperă o gamă largă de aplicații funcționale, inclusiv documentarea codului sursă și depanarea logicii codului. Optimizează fluxul de lucru în Vim prin reducerea numărului de taste necesare pentru a gestiona delimitatorii de comentarii în diverse limbaje de programare.
Facilitates the creation of clean, readable documentation blocks within the source code.
TSDoc este un standard de documentație și o specificație pentru scrierea comentariilor structurate în codul TypeScript. Oferă un sistem portabil pentru definirea metadatelor, etichetelor și referințelor încrucișate în interiorul codului sursă pentru a asigura parsarea și randarea consistentă în diferite instrumente. Proiectul include un parser de comentarii doc care convertește comentariile într-un arbore de sintaxă structurat și un validator care impune consistența sintaxei. Permite definirea de etichete de documentație personalizate prin fișiere de configurare externe și suportă moduri multiple de validare a sintaxei pentru a asista la conformitatea cu specificațiile. Specificația acoperă o gamă largă de nevoi de documentare API, inclusiv marcarea etapelor de lansare, stabilitatea și deprecierea. Suportă detalierea parametrilor funcțiilor, valorilor returnate și tipurilor de excepții, precum și gestionarea vizibilității interne, moștenirii și referințelor încrucișate între declarații.
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.
Acest proiect este o colecție de analize tehnice și cod sursă adnotat care oferă o analiză detaliată a bibliotecii de utilitare JavaScript Underscore. Servește ca documentație a codului sursă care mapează logica funcțională de nivel înalt către linii specifice de cod prin comentarii tehnice. Analiza se concentrează pe studiul modelelor JavaScript și documentarea codului legacy. Examinează constrângerile istorice ale limbajului și strategiile de compatibilitate cu browserele pentru a explica evoluția modelelor de utilitare și raționamentul din spatele unor alegeri arhitecturale specifice în versiunile mai vechi ale bibliotecii. Proiectul acoperă mai multe domenii tehnice, inclusiv descompunerea bibliotecilor monolitice în articole modulare, studiul modelelor de codare reutilizabile pentru funcții utilitare și partiționarea codului sursă în categorii funcționale.
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.