6 repositorios
Guidelines for designing function signatures to avoid ambiguous or multi-purpose flags.
Distinct from Boolean Flag Generators: Candidates focus on CLI flags or bit-vectors; this is about high-level clean code function signature design.
Explore 6 awesome GitHub repositories matching software engineering & architecture · Function Parameter Design. 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 es un estándar de documentación y especificación para escribir comentarios estructurados en código TypeScript. Proporciona un sistema portátil para definir metadatos, etiquetas y referencias cruzadas dentro del código fuente para garantizar un análisis y renderizado consistentes en diferentes herramientas. El proyecto incluye un analizador de comentarios de documentación que convierte los comentarios en un árbol de sintaxis estructurado y un validador que aplica la consistencia de la sintaxis. Permite la definición de etiquetas de documentación personalizadas a través de archivos de configuración externos y admite múltiples modos de validación de sintaxis para ayudar con el cumplimiento de la especificación. La especificación cubre una amplia gama de necesidades de documentación de API, incluyendo el marcado de etapas de lanzamiento, estabilidad y obsolescencia. Admite detallar parámetros de funciones, valores de retorno y tipos de excepciones, así como gestionar la visibilidad interna, la herencia y las referencias cruzadas entre declaraciones.
Uses structured tags to associate descriptive explanations with specific function parameters.
This project is a comprehensive guide and set of engineering standards for writing readable, maintainable, and scalable JavaScript code. It provides a framework for software architecture, refactoring patterns, and clean coding practices designed to improve codebase health and longevity. The guide emphasizes the application of SOLID principles and architectural strategies such as dependency inversion and the separation of concerns. It focuses on transforming complex conditional logic through polymorphism and refactoring, while promoting a transition from imperative loops to declarative functio
Encourages splitting functions into separate versions instead of using boolean flags to force dual behavior.
SwiftTips es una colección curada de guías, bibliotecas y patrones de diseño centrados en el dominio del lenguaje Swift, la arquitectura de aplicaciones y el diseño de APIs. Proporciona un recurso técnico para implementar técnicas de codificación avanzadas y mejores prácticas arquitectónicas. El proyecto enfatiza la creación de interfaces seguras por tipos (type-safe) y conversacionales mediante la composición estratégica de protocolos y genéricos. Ofrece patrones especializados para construir sistemas de interfaz de usuario modulares y gestionar jerarquías de vistas complejas, junto con estrategias integrales para pruebas unitarias e inyección de dependencias. El recurso cubre una amplia gama de capacidades, incluyendo primitivas de programación funcional, utilidades avanzadas del sistema de tipos y estrategias de modelado de datos. También detalla técnicas para el manejo de errores, gestión de memoria y el desarrollo de interfaces de usuario responsivas.
Uses internal and external parameter names in documentation comments to ensure correct parser mapping.