Уровень 0 · материалов: 15
Сюда относятся документы, посвященные методам повышения качества, читаемости и эстетики исходного кода, но не документы о системных причинах низкого качества ПО в индустрии.
Общие признаки: читаемость кода, снижение когнитивной нагрузки, стандарты оформления и именования, поддерживаемость программного обеспечения, принципы написания красивого кода
Группа выше: Чистый код и читаемость
Смысл: The main idea is that 'beautiful' source code is achieved through strict adherence to consistency, minimalism in documentation, and a pragmatic approach to language features (like C++ STL), ensuring that the code is self-explanatory and easy to maintain.
A game developer analyzes the Doom 3 source code to identify the specific coding standards and stylistic choices that make it a masterpiece of readability and structure.
Смысл: The main idea is that 'beautiful code' is defined by its readability and manageability, which can be systematically achieved by applying principles of linearity, brevity, and self-documentation to reduce cognitive load for the developer.
Beautiful code is professional code that is linear, minimal, and self-documenting, making it easier to read, maintain, and evolve.
Смысл: The main idea is that writing high-quality C code requires more than just functional correctness; it demands discipline in style, architectural organization, and the use of advanced language features and tools to ensure maintainability and stability.
A guide to professional C programming focusing on clean code style, project structure, memory safety, and the use of advanced keywords for system-level development.
Смысл: The main idea is that clean, 'beautiful' code is achieved by adhering to a strict logical hierarchy where data and functions are declared as close to their usage as possible and where the structure of the code visually represents its logical intent.
The author identifies ten common programming patterns and language limitations that hinder code readability and beauty, proposing hierarchical and intuitive alternatives.
Смысл: The main idea is that professional software development, especially in a flexible language like C++, should prioritize simplicity, standardization, and team collaboration over individual technical brilliance and over-engineering to ensure the product remains maintainable and successful.
C++ developers should avoid 'coding as art' and instead embrace simplification and standardization to ensure software is maintainable by a team rather than just a few 'stars'.
Смысл: The main idea is to establish a consistent, readable, and professional coding style for C++ developers to reduce technical debt and improve team collaboration through standardized naming and formatting.
A comprehensive guide detailing stylistic rules for C++ programming to ensure code clarity and maintainability.
Смысл: The main idea is that concise, well-decomposed code is superior to voluminous code because it reduces cognitive load, improves testability, and simplifies long-term maintenance.
Write the minimum amount of code necessary by leveraging existing tools and breaking complex logic into small, single-purpose functions to improve readability and maintainability.
Смысл: The main idea is that professional C code for embedded systems should be designed for maximum testability, modularity, and maintainability through strict adherence to formatting rules, early error detection, and a clear architectural hierarchy.
A professional guide for C programmers focusing on firmware development, emphasizing modularity, strict coding standards, and the elimination of 'hidden' bugs through rigorous testing and compiler flags.
Смысл: The main idea is that 'good taste' in programming is the ability to simplify complex problems by eliminating boundary cases and redundant logic, leading to code that is more elegant, efficient, and maintainable.
Programming 'good taste' involves refactoring code to eliminate boundary cases and unnecessary conditionals, resulting in simpler and more efficient solutions.
Смысл: The main idea is that 'beautiful code' is a subjective concept that evolves with experience, shifting from superficial aesthetics to pragmatic values like minimalism, readability, and maintainability, though all agree that functionality is the absolute priority.
Senior Yandex developers discuss whether code should be 'beautiful,' concluding that while beauty is subjective, functionality and readability are essential for collaboration.
Смысл: The text argues that source code should be treated as a readable text. By utilizing fluent interfaces and carefully chosen naming conventions, developers can create code that reads like a natural language, which significantly reduces the cognitive load required for maintenance and understanding.
The author demonstrates how to refactor technical C# code into human-readable 'text' using fluent interfaces and strategic naming to reduce cognitive load.
Смысл: The main idea is that source code should be written for human readability first and machine execution second. The author advocates for breaking down complex logic into small, well-named functions to reduce cognitive load and improve maintainability.
Write code that is easy for humans to read like a book, rather than code that forces the reader to mentally simulate the compiler's execution.
Смысл: The main idea is that minimizing vertical and horizontal waste in source code (conciseness) reduces cognitive load and physical effort, leading to higher productivity and better code readability.
The author advocates for a highly condensed C++ coding style to reduce scrolling and cognitive overhead, arguing that brevity increases developer efficiency.
Смысл: The main idea is to propose and discuss a unified C# coding standard for a specific professional community to improve code readability and consistency in shared examples.
A proposal for a standardized C# coding style guide for the Habrahabr community covering naming conventions, structure, and code volume.
Смысл: The text serves as a comprehensive cheat sheet for the Qt Coding Style, arguing that strict adherence to these formatting and naming conventions is essential for creating readable, maintainable, and professional C++ code within the Qt ecosystem.
A comprehensive breakdown of the Qt framework's official coding style guidelines, covering indentation, naming conventions, spacing, and structural formatting to ensure code readability.