Прозрачность – это один из принципов объектно-ориентированного проектирования, который помогает разработчикам сохранять код читаемым и понятным.
Когда вы смотрите на класс или методы, сразу должно быть очень очевидно, что он делает, в течение следующей 1 минуты должно быть очевидно, как он делает то, что он делает. Вы, как программист, должны быть в состоянии понять фрагмент кода, который вы написали, через несколько месяцев или даже лет, когда вы смотрите на него. Более того, другим тоже должно потребоваться столько же времени, сколько вам потребовалось через 6 лет, чтобы понять написанный вами код. Например, когда кто-либо смотрит на имя класса и его переменные-члены и методы, он должен понимать, что они делают и как, без каких-либо усилий.
Название класса должно объяснять, что он делает или что он обозначает.
В имени переменной должно быть указано, для чего она используется.
Имя метода должно объяснять действие, которое выполняется при вызове метода.
В имени метода должен быть глагол, чтобы это произошло.
То же самое относится и к названиям объектов, в них должно быть указано, для чего они используются и в каком контексте.
Обычно класс называется как существительное, например класс сотрудника.
В качестве примера, класс Employee может иметь переменные для поддержания состояния объекта employee. Когда задача класса Employee состоит в том, чтобы сохранить сведения о возрасте, зарплате, имени, отделе сотрудника, тогда имена переменных должны быть такими, как возраст, зарплата, имя, отдел. Мы должны использовать самое простое имя, которое определяет, для чего предназначены переменные.
Вот еще один пример для методов. Когда метод увеличивает зарплату сотрудника, назовите его как increment Salary(). Вы можете увеличить зарплату, указав процент приращения или добавив плавающую сумму к существующей зарплате. Затем назовите их по-другому, например
incrementSalaryByPercentage(double percentage) incrementSalaryByAmount(long additionalAmount)
Теперь предположим, что отдел состоит из 5 сотрудников. и один из них – ИТ-менеджер, другой – бухгалтер, еще один менеджер по персоналу и два программиста. Вы создадите 5 объектов одного и того же класса Employee в классе Department. но назовите имя каждого сотрудника, объект должен объяснять их роль, например, ИТ-менеджер и т.д.
Когда вы начинаете создавать классы, начинайте сверху вниз. Это означает, что сначала напишите пользовательские интерфейсы, чтобы обеспечить прозрачность. Такие вещи, как сервисы, базы данных и т.д., Должны находиться в нижней части структуры и записываться позже. Это должно быть сделано таким образом, чтобы, даже если есть изменения на техническом уровне, например, как получить доступ к базе данных, это не должно влиять на верхний уровень.
Таким образом, просто следуя хорошему соглашению об именовании, мы можем сделать наш код простым для понимания и прозрачным.
Для получения оригинальной записи, пожалуйста, обратитесь к мой блог Вы можете увидеть похожие сообщения в разделе Объектно-ориентированный дизайн здесь
Оригинал: “https://dev.to/dibyojyoti/how-to-apply-transparency-in-oo-programming-2ffo”