17 个仓库
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 是一个 VSCode 扩展,旨在自动生成和更新源文件顶部的标准化注释块。它作为一个文件元数据管理器和自动化代码文档工具,在保存时直接在代码中跟踪作者、修改时间和文件路径。 该工具从本地 Git 配置中同步作者姓名和电子邮件地址以填充页眉字段。它还具有源代码注释装饰器,能够插入装饰性注释艺术和视觉图案来组织代码段。 该扩展涵盖了广泛的功能,包括通过参数提取自动生成函数文档字符串、用于版权声明和许可证的模板化自定义,以及特定语言的分隔符映射。它包括用于排除特定目录或文件扩展名的过滤机制,并采用变更检测来还原琐碎的元数据更新,从而防止冗余的版本控制提交。
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.
本项目是一个全面的 Python 编程教育材料合集,包括教程、练习与精选代码示例。它作为一个学习课程与软件工程工具包,利用 Jupyter Notebooks 将可执行代码与描述性教育文本相结合。 该仓库提供了构建大语言模型应用的实践指南,例如检索增强生成(RAG)系统、有状态 AI 代理与机器学习工作流。它通过提供结构化的代理编码工作流脱颖而出,涵盖了上下文窗口蒸馏、与提供商无关的模型路由以及模式强制的结构化输出。 这些材料涵盖了广泛的软件工程能力,包括使用分布式任务队列的异步编程、使用 REST API 的 Web 应用开发以及数据分析工作流。它还包括用于掌握面向对象设计、实现 CI/CD 流水线以及应用专业 Linting 与格式化标准的资源。
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 是一个数据科学课程和教育资源,专为精通 R 编程语言而设计。它为导入、整理、转换和可视化数据的端到端过程提供了结构化的学习路径。 该项目强调可重复的数据科学指南和全面的数据整理课程。它包括关于用于分层数据可视化的图形语法(grammar of graphics)的专业教程,以及使用 Quarto 创建的融合可执行代码与叙述性文本的技术出版物。 该材料涵盖了广泛的分析能力,包括来自不同来源的数据摄取、关系数据连接以及分类变量的管理。它还涉及数据清洗、数学建模以及多格式专业报告和演示文稿的生成。 该课程侧重于函数式编程和整洁数据(tidy data)原则的实际应用,以创建透明且可重复的分析。
Teaches how to annotate code logic with human-readable text for better developer understanding.
Nerdcommenter 是一个 Vim 注释插件和文本操作工具,旨在自动化插入、删除和格式化特定语言的代码注释。它作为一个实用工具,用于切换注释标记并对齐注释块,以改善代码组织。 该工具提供了注释状态切换和分隔符切换的能力,允许用户从单行或选定的文本块中添加或删除标记。它包括用于注释块格式化的功能,以确保视觉一致性,以及注释掉代码以禁用执行的能力。 该插件涵盖了广泛的功能应用,包括源代码文档编写和代码逻辑调试。它通过减少管理各种编程语言注释分隔符所需的按键次数,优化了 Vim 工作流。
Facilitates the creation of clean, readable documentation blocks within the source code.
TSDoc 是一个用于在 TypeScript 代码中编写结构化注释的文档标准和规范。它提供了一个可移植的系统,用于在源代码中定义元数据、标签和交叉引用,以确保在不同工具链之间实现一致的解析和渲染。 该项目包含一个文档注释解析器,可将注释转换为结构化语法树,以及一个强制执行语法一致性的验证器。它允许通过外部配置文件定义自定义文档标签,并支持多种语法验证模式以协助规范合规性。 该规范涵盖了广泛的 API 文档需求,包括标记发布阶段、稳定性和弃用状态。它支持详细说明函数参数、返回值和异常类型,以及管理内部可见性、继承和声明之间的交叉引用。
Establishes a standardized way to write documentation comments for TypeScript code across different tools.
Textract 是一个多格式文本提取工具和解析器。它提供了一个统一的接口,用于从各种来源(包括文档、图像和音频文件)中提取纯文本。 该系统作为 PDF 和电子表格的文档内容解析器、使用光学字符识别 (OCR) 的图像文本提取器,以及音频录音的语音转文本转录器。
Maps PDFs and spreadsheets to a common internal representation for consistent text retrieval.
这是一个技术分解和带注释的源代码集合,提供了对 Underscore JavaScript 实用程序库的详细分析。它作为源代码文档,通过技术评论将高级功能逻辑映射到特定的代码行。 该分析侧重于 JavaScript 模式研究和遗留代码文档。它检查了历史语言约束和浏览器兼容性策略,以解释实用程序模式的演变以及旧版本库中特定架构选择背后的原因。 该项目涵盖了几个技术领域,包括将单体库分解为模块化文章、研究实用程序函数的重用编码模式,以及将源代码划分为功能类别。
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.