6 Repos
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 ist ein Dokumentationsstandard und eine Spezifikation für das Schreiben strukturierter Kommentare in TypeScript-Code. Es bietet ein portables System zur Definition von Metadaten, Tags und Querverweisen innerhalb des Quellcodes, um eine konsistente Analyse und Darstellung über verschiedene Toolings hinweg zu gewährleisten. Das Projekt enthält einen Doc-Kommentar-Parser, der Kommentare in einen strukturierten Syntaxbaum umwandelt, sowie einen Validator, der die Syntaxkonsistenz erzwingt. Es ermöglicht die Definition benutzerdefinierter Dokumentations-Tags über externe Konfigurationsdateien und unterstützt mehrere Syntax-Validierungsmodi, um die Einhaltung der Spezifikation zu unterstützen. Die Spezifikation deckt eine breite Palette von API-Dokumentationsanforderungen ab, einschließlich der Kennzeichnung von Release-Stufen, Stabilität und Deprecation. Sie unterstützt die Detaillierung von Funktionsparametern, Rückgabewerten und Exception-Typen sowie die Verwaltung von interner Sichtbarkeit, Vererbung und Querverweisen zwischen Deklarationen.
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 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.