2 dépôts
Guidelines and practices for choosing clear, searchable, and pronounceable identifiers to improve code readability.
Distinct from Named Return Values for Clarity: The candidates focus on narrow technical implementations like name mangling, collision avoidance, or specific return value naming, whereas this is about general clean code naming principles.
Explore 2 awesome GitHub repositories matching software engineering & architecture · Variable Naming Conventions. Refine with filters or upvote what's useful.
Ce projet est un guide de code propre (clean code) Python et une ressource de refactoring. Il fournit une collection de principes d'artisanat logiciel et d'exemples conçus pour améliorer la lisibilité et la maintenabilité du code source Python. La ressource se concentre sur l'optimisation du nommage des variables pour supprimer le mappage mental et la division des fonctions en unités à but unique. Elle fournit des directives pour réduire la duplication de code et organiser la logique afin de garantir que les composants restent faciles à étendre et à maintenir. Le contenu couvre l'architecture logicielle et la qualité de conception, y compris l'implémentation des principes SOLID et des modèles de conception (design patterns) standard de l'industrie. Il aborde également la gestion des effets de bord et l'utilisation de workflows de test automatisés au sein d'environnements virtuels.
Choose pronounceable and searchable names for variables to increase clarity and remove the need for mental mapping.
This project is a static analysis tool and linter for Elixir designed to enforce a unified visual structure across codebases. It serves as a specification for code formatting, naming conventions, and documentation standards. The tool provides a standardized system for casing and prefixes used in files, functions, and variables. It also establishes guidelines for formatting module and function descriptions to ensure consistent technical documentation. The project covers a broad range of code quality areas, including the organization of module layouts, the implementation of commenting patterns
Dictates casing and prefix patterns for variables and booleans to ensure semantic consistency.