8 Repos
Standardized comment tags used to structure source code for automated API documentation generation.
Distinct from Documentation-Driven Standards: Focuses on the specific use of source code annotations for API generation, whereas Documentation-Driven Standards is the broader philosophy.
Explore 8 awesome GitHub repositories matching software engineering & architecture · API Documentation Annotations. Refine with filters or upvote what's useful.
This project is a software engineering reference that provides a cross-language formatting standard and industry-standard practices for architectural patterns, memory management, and identifier naming. Its primary purpose is to implement a unified set of indentation and whitespace rules applied consistently across multiple distinct programming environments. The project specializes in technical documentation localization, providing Chinese language translations of official programming style guides. It maps original English coding standards to Chinese language references to maintain meaning acr
Provides a system of standardized comment tags and markers to ensure a consistent structure for automated API documentation.
apidoc is a source-code API documentation generator that parses specialized annotations within comments to automatically create a searchable API documentation website. It functions as an annotation-based API parser and a static documentation site generator, extracting definitions directly from the codebase to maintain a synchronized reference. The tool is designed as a multi-language parser, using configurable regular expressions to extract metadata from various programming languages. It can also serve as a JSON API definition exporter, converting source-code comments into raw JSON files for
Uses a regex-based parsing system to extract API metadata from comments across various programming languages.
This project is a production-ready template for building RESTful APIs using Node.js and the Express web framework. It provides a pre-configured structure for backend services, integrating a MongoDB Mongoose ODM framework for data modeling and a token-based security system for managing user identity. The boilerplate distinguishes itself through automated API documentation generated via Swagger by parsing code comments. It implements a layered controller architecture and a middleware-based request pipeline to separate routing logic from business logic and security processing. The system covers
Uses standardized JSDoc comment tags to automatically generate technical API specifications.
RuoYi-Vue3 is a full-stack administrative dashboard and permission management framework built with SpringBoot and Vue 3. It serves as an enterprise management backend providing a decoupled architecture that separates the API from the user interface. The project features a low-code CRUD generator that automatically produces frontend and backend boilerplate code and API documentation from database tables. It implements a comprehensive role-based access control system for managing users, departments, and granular permissions at the menu and button levels, secured by stateless JSON Web Token auth
Uses source code annotations to automatically generate interactive technical API documentation.
TypeSpec is a language for defining cloud API shapes and generating OpenAPI, JSON Schema, and client/server code from a single source of truth. It functions as a protocol-agnostic API designer that models REST, gRPC, and other API protocols using a unified, extensible syntax, with a decorator-based metadata system for attaching metadata, validation rules, and lifecycle visibility to API models and operations. The compiler produces OpenAPI 3.0 specifications and other artifacts, and the tool supports declaring API versions and tracking changes to models, properties, and operations across releas
Attaches descriptive text to models, operations, and properties using decorators for generating external documentation.
cheats.rs ist eine Rust-Syntaxreferenz und technische Dokumentationsressource, die als statische Website bereitgestellt wird. Sie dient als kuratierte Sammlung von Beispielen und Mustern, die beim Erlernen der Sprache Rust unterstützen sollen. Das Projekt deckt eine breite Palette an Sprachkonstrukten ab, einschließlich Speicherverwaltung, der Verwendung von Generics und der Implementierung asynchroner Logik. Es bietet Anleitungen zur Definition von Datenstrukturen, zur Verwaltung von Speicherreferenzen und zur Organisation von Codemodulen. Zusätzlich werden Muster für Kontrollfluss, Pattern Matching und die Verwendung von Makros behandelt sowie Anweisungen für die Durchführung unsicherer Operationen und die Aufrechterhaltung der API-Stabilität gegeben.
Explains the use of specialized comments for generating API references and internal implementation notes.
lua-language-server ist ein statisches Analysetool und Typ-Checker für die Sprache Lua, der das Language Server Protocol implementiert. Er bietet ein System zur Erkennung von Typ-Diskrepanzen, ungenutztem Code und Logikfehlern in Quelldateien. Das Projekt bietet ein inferenzbasiertes Typsystem, das Variablentypen ableitet und optionale Annotationen sowie Meta-Dateien zur Durchsetzung von Typsicherheit unterstützt. Es ermöglicht die Definition benutzerdefinierter Typen und Funktionssignaturen, einschließlich Unterstützung für Overloads und Sichtbarkeitskontrollen für Member. Der Server bietet eine breite Palette an IDE-Funktionen, einschließlich Echtzeit-Code-Autocompletion, Symbol-Refactoring sowie Navigation zu Definitionen und Implementierungen. Er enthält einen Code-Formatter und einen Dokumentationsgenerator, der Symbole und Annotationen extrahiert, um Markdown- und JSON-Dateien zu produzieren. Der Server kann aus dem Quellcode gebaut und an spezifische Sprachversionen und Laufzeitumgebungen angepasst werden.
Extracts symbols and annotations from Lua source code to generate structured Markdown and JSON documentation.
This project provides a set of software architecture guidelines, Lisp coding standards, and functional programming patterns for Clojure development. It establishes best practices for implementing declarative logic and managing shared state through the use of persistent data structures and atomic references. The guide covers standards for documenting public APIs and organizing project directories to ensure portable library distribution. It details the application of consistent formatting and naming rules to improve source code readability and team collaboration. The scope extends to idiomatic
Defines standards for using docstrings and metadata tags to document public APIs.