45 个仓库
The use of non-executable text within source code for documentation and internal notes.
Distinct from Code Annotations: Candidates focus on AI generation or AST linking, not the basic language feature of writing comments.
Explore 45 awesome GitHub repositories matching programming languages & runtimes · Code Commenting. Refine with filters or upvote what's useful.
This project is a collection of programming language references and syntax cheat sheets designed for rapid developer onboarding. It serves as a library of code-based documentation that uses valid source code files to provide whirlwind tours of various language specifications. The project focuses on programming language learning by providing concise, commented code examples that explain core features and syntax in place. This approach enables developers to quickly grasp language-specific patterns, data types, and execution flow through a consistent reference format. The content covers a broad
Provides inline usage comments and expected outputs directly within source code to explain language features.
Stylus is a CSS preprocessor that transforms a dynamic language into standard CSS. It utilizes a compilation workflow to enable the use of variables, nesting, and arithmetic, which are then rendered into stylesheets for use in frontend asset pipelines. The project is distinguished by a flexible syntax that allows for indentation-based styling, meaning curly braces, colons, and semicolons can be omitted. It further differentiates itself through a JavaScript-driven plugin pipeline and the ability to extend the native syntax with custom JavaScript functions for complex logic. Its capability sur
Supports single-line and multi-line comments for documentation and excluding code from the final CSS output.
ReflectionDocBlock is a PHP docblock parser and doc-comment metadata extractor. It functions as a reflection wrapper that extends the standard PHP Reflection API to convert raw documentation blocks into structured objects. The library provides tools for PHP documentation parsing and reflection tooling. It enables the extraction of structured metadata and annotations from reflection objects or raw doc-comment strings to support automated API documentation and static code analysis.
Converts raw PHP documentation blocks into structured objects for use in automated documentation tools.
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
Defines how docstrings are interpreted using custom tags, link resolution, and standard documentation formats.
VVDocumenter-Xcode 是一个用于 Xcode 环境的 IDE 文档工作流工具和自动化实用程序。它充当文档生成器,通过提取参数和返回值,自动为 Swift 源代码创建结构化的注释块。 该工具充当注释助手,通过使用自定义触发序列减少手动输入。它识别方法签名和元数据,将标准化的文档头直接注入编辑器。 该系统涵盖静态源分析和基于模板的块生成,以确保一致的结构格式。它包括用于调整触发序列、缩进样式以及生成的文档块整体格式的配置选项。
Automatically creates structured documentation comment blocks by extracting parameters and return values from source code.
This repository is a collection of Python code examples that demonstrate how to use Google Cloud Platform services and APIs. Each sample is organized as a self-contained directory with its own dependencies, making it independently runnable and testable. The samples rely on Google's auto-generated Python client libraries and standardize invocation through command-line argument parsing, with configuration read from environment variables for portability across development and CI environments. The examples cover authentication setup using the gcloud CLI, along with practical demonstrations for se
Embeds usage instructions and expected outputs directly in source code comments for human readers and automated testing.
This project is an interactive programming education resource and tutorial designed for learning the Rust programming language and systems programming concepts. It provides a collection of runnable and editable code examples that serve as a practical reference for language syntax and implementation. The resource features an interactive code sandbox that allows users to execute and test code snippets in real time. It emphasizes the verification of technical accuracy by executing embedded code blocks during the build process to ensure all examples remain functional. The content covers a compre
Covers the use of line and block comments for providing internal documentation within the code.
CodeGeeX2 is a large language model and AI programming assistant designed to generate, translate, and document source code across multiple programming languages. It functions as a multilingual code model that converts natural language prompts into executable code and technical documentation. The project provides a self-hosted AI inference endpoint, allowing the model to be exposed as a web-accessible service. This enables external development tools to integrate automated programming tasks via network calls. Its core capabilities cover multilingual code generation, automated source code docum
Provides automated generation of structured documentation comment blocks from existing source code.
This project is a curated configuration suite and development environment bootstrapper designed to optimize Zsh and Vim. It provides a collection of dotfiles, plugins, and scripts that automate the installation of system packages and shell tools to standardize a local workstation. The suite focuses on creating a consistent experience across the command line and text editor. It implements a Zsh shell framework with syntax highlighting and fuzzy matching, alongside a Vim configuration that includes advanced plugins and modal editing. It also provides a set of sane defaults and Vim-style keybind
Provides shortcuts to quickly toggle comments on single lines or blocks of code.
Rockstar is an esoteric programming language whose syntax is inspired by 1980s hard rock and heavy metal lyrics, making programs read like song lyrics. It uses poetic number literals, where the length of each word in a phrase is parsed as a decimal digit to initialize numeric variables, and pronoun-based variable references, where words like "it" and "they" resolve to the most recently assigned or compared variable at runtime. The language can be compiled to WebAssembly and run inside a web page for in-browser code execution. The language distinguishes itself through a lyric-driven parsing sy
Inserts comments in source code using parentheses, hash symbols, or brackets that are ignored during execution.
This project is a Java persistence generator and database mapping tool designed to produce boilerplate persistence layer code. It translates database schemas and column comments into structured Java annotations and mapping files, replacing the need for manual configuration writing. The tool provides a visual interface for generating code and manages secure database access through SSH tunneling. It allows users to connect to private databases via encrypted tunnels to safely extract schemas without exposing the database to the public internet. The system includes capabilities for database sche
Converts database column comments into code annotations to improve the clarity of field documentation.
Doxygen is a source code documentation generator and multi-language API reference tool. It extracts annotated comments from source code to create structured technical manuals and searchable software libraries in formats including HTML, LaTeX, and PDF. The project functions as a static code analysis visualizer, generating call graphs, class diagrams, and inheritance hierarchies to illustrate codebase structure. It also serves as an XML documentation export engine, producing structured metadata that can be transformed via XSLT or third-party tools. Beyond API extraction, the tool provides a Ma
Provides a utility to insert skeleton comment blocks into source code to standardize technical documentation.
Rushstack 是一个用于管理大规模 TypeScript 单体仓库(monorepo)的综合工具集,为构建流水线自动化、依赖协调和静态分析提供了框架。它作为一个增量构建编排器和管理系统,旨在在共享工作区中的多个包之间保持一致性和性能。 该系统通过基于有向无环图和基于内容哈希的增量模型脱颖而出,确保仅重建受影响的项目。它通过与 S3、Azure 和 HTTP 集成的远程构建工件缓存进一步优化开发工作流,并利用基于符号链接的工作区管理来实现本地更改的即时可见性。 该工具集涵盖了广泛的功能,包括自动化发布工作流、API 合约分析以及通过标准化 Linting 配置文件强制执行企业代码质量。它还为资产打包、TypeScript 转译以及从 JSON 模式和静态资产生成类型定义提供了广泛支持。 其他实用领域包括本地化管理、许可证声明生成以及具有同步进程输出的命令行界面编排。
Checks documentation comments against the TSDoc standard to ensure compatibility with extraction tools.
emmet-vim is a plugin for Vim that functions as a markup automation tool and code expander. It allows for the rapid generation of HTML and CSS structures by expanding shorthand text expressions into full code elements. The tool provides a set of shortcuts for wrapping, balancing, and manipulating tags. It includes a text object extension that enables navigation and editing commands for jumping between nested element boundaries. The project covers a range of capabilities for frontend code refactoring and document hierarchy restructuring. These include tag wrapping, element removal, attribute
Provides keyboard shortcuts to quickly comment or uncomment blocks of markup code.
SWIG is a tool that generates wrapper code to expose C and C++ libraries to a wide range of higher-level programming languages. It reads annotated C/C++ header files and produces language-specific bindings from a single interface definition, supporting languages such as Python, Java, Ruby, C#, Perl, and many others. The generated wrapper code is free from the project's GPL license, allowing users to distribute it under their own terms. The tool handles modern C++ features including templates, namespaces, smart pointers, and constructs up to C++20 through specialized parsing and code generatio
Converts Doxygen-style comments in C++ code into equivalent documentation for generated bindings.
Anthony's ESLint config preset
Triggers micro-codemods like converting arrow functions or sorting objects via special comment markers.
Embeds explanatory comments within code examples to bridge design concepts and implementation.
该项目是一个 Vim 注释插件和语言感知注释器,旨在将特定于文件类型的注释字符应用于源代码。它充当文本对象扩展,允许切换选定行或文本块上的注释标记。 该插件利用 Vim 动作和范围来确定要修改的特定文本,从而自动化添加或移除注释标记的过程。它通过根据当前文件类型自动映射注释字符来提供多语言语法支持。 用户可以为特定文件类型定义自定义注释字符,以确保跨不同编程语言的兼容性。
Functions as a language-aware system for toggling comment markers across various programming languages.
Periphery is a static analysis tool and dead code detector for Swift projects. It identifies unreferenced classes, structs, functions, and properties, and serves as an API surface optimizer to find public declarations that can be restricted to internal access. The tool includes specialized scanning for Interface Builder files, such as storyboards and XIBs, to ensure UI-connected members are not incorrectly flagged as unused. It also provides automated code removal to eliminate identified dead code and unused parameters directly from source files. Its analysis capabilities cover the detection
Supports inline source code annotations to manually instruct the analyzer to ignore specific symbols or files.
The C/C++ extension for Visual Studio Code provides language support for C and C++ programming, including IntelliSense-powered code editing, navigation, and debugging capabilities. It enables syntax highlighting, code completion, hover information, and error checking for C and C++ source files, along with features like semantic colorization, symbol search, and call hierarchy exploration. The extension offers comprehensive debugging support for C/C++ programs, including launching debug sessions with breakpoints, stepping through code, and inspecting variables. It supports debugging multi-threa
Creates a structured documentation comment block when typing / and pressing Enter.