5 dépôts
Practices for documenting function signatures to isolate high-level usage from internal implementation.
Distinct from Function Parameter Design: Focuses on the documentation and description of the interface rather than the structural design of the parameters.
Explore 5 awesome GitHub repositories matching software engineering & architecture · Interface Documentation. Refine with filters or upvote what's useful.
This project is a comprehensive Python coding guide and software engineering resource focused on professional development practices. It provides a detailed collection of idiomatic techniques, design patterns, and architectural strategies to improve code quality and maintainability. The guide emphasizes advanced design patterns such as dependency injection, data-driven design, and the application of SOLID principles for object-oriented design. It distinguishes itself by covering sophisticated structural strategies, including class-based decorators, the separation of interfaces from implementat
Provides a practice for creating high-level descriptions of function purposes and parameters.
The AWS SDK for PHP is a software development kit that provides HTTP client classes for every supported Amazon Web Service, enabling PHP applications to send authenticated requests and receive structured, typed response objects. It includes a credential resolution chain that automatically locates credentials from environment variables, instance profiles, or configuration files, and supports promise-based asynchronous execution for running multiple API calls concurrently to improve throughput. The SDK distinguishes itself through a middleware pipeline architecture that allows interception and
Documents input parameters and output structures for each service operation in the SDK.
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
Tags operation parameters, responses, and template parameters within doc comments to produce structured documentation.
TSDoc est un standard de documentation et une spécification pour l'écriture de commentaires structurés dans le code TypeScript. Il fournit un système portable pour définir des métadonnées, des balises et des références croisées au sein du code source afin d'assurer une analyse et un rendu cohérents à travers différents outils. Le projet inclut un analyseur de commentaires de documentation qui convertit les commentaires en un arbre de syntaxe structuré et un validateur qui applique la cohérence syntaxique. Il permet la définition de balises de documentation personnalisées via des fichiers de configuration externes et prend en charge plusieurs modes de validation de syntaxe pour aider à la conformité aux spécifications. La spécification couvre un large éventail de besoins en documentation d'API, y compris le marquage des étapes de publication, la stabilité et la dépréciation. Elle prend en charge le détail des paramètres de fonction, les valeurs de retour et les types d'exception, ainsi que la gestion de la visibilité interne, de l'héritage et des références croisées entre les déclarations.
Uses structured tags to associate descriptive explanations with specific function parameters.
SwiftTips is a curated collection of guides, libraries, and design patterns focused on Swift language mastery, application architecture, and API design. It provides a technical resource for implementing advanced coding techniques and architectural best practices. The project emphasizes creating type-safe and conversational interfaces through strategic protocol composition and generics. It offers specialized patterns for building modular UI systems and managing complex view hierarchies, alongside comprehensive strategies for unit testing and dependency injection. The resource covers a broad s
Uses internal and external parameter names in documentation comments to ensure correct parser mapping.