DEV Community: Ahmed Atef

The DRY Principle

Ahmed Atef — Tue, 29 Mar 2022 10:04:52 +0000

عندما نفكر في ممارسة أفضل الحلول البرمجية أثناء برمجة الأكواد ، فعليك بشكل أساسي أن تتذكر هذا المبدأ
(Don’t Repeat Yourself) 🔄
والذي يُلخص التعبير التالي
“Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.”

إذاً يستهدف هذا المبدأ إلى تقليل بل تجنب التكرارات الزائدة عن الكود بلافائدة ، فلنتعجب عندما نقضي المزيد من الوقت في تكرار الكود وفي الحقيقة إن الغرض من معظم التطبيقات هو إتوماتيكية المهام والوظائف مواضع التكرار في السيستم

📢 فما الحل ؟؟؟

يكمُن الحل في استبدال الدوال أو الوظائف المكررة بأخرى مُجردة أو بتجميعها تحت مظلة وظيفة واحدة فردية ومن ثم إستدعائها في أي مكان يتطلب تنفيذ مهام هذة الدالة.
ويتحقق هذا من خلال الإقتراحات التالية:
✅Creating an API reference guide from comments
✅Automatically detecting unit tests through an annotation or naming convention
✅Generating both PDF and HTML documentation from a single markup source
✅Deriving object classes from a database schema

When following the coding best practices, remember the DRY Principle. DRY stands for Don’t Repeat Yourself, and the DRY Principle states that “Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.” This is also sometimes known as DIE: Duplication Is Evil.

The Principle aims at reducing repetition and redundancies within the software engineering process. The purpose for most applications is to automate repetitive tasks, so why spend time repeating code?

This is achieved by replacing repetitions with abstractions or by grouping code into functions and Keeping a definitive version of your code in a single place, and then let this version drive all other uses. You can do this by:

✅Creating an API reference guide from comments
✅Automatically detecting unit tests through an annotation or naming convention
✅Generating both PDF and HTML documentation from a single markup source
✅Deriving object classes from a database schema

When you follow the DRY principle, you are saving yourself time and energy and following one of the most important coding best practices.

The YAGNI Principle

Ahmed Atef — Tue, 29 Mar 2022 10:00:48 +0000

أحد المبادئ الهامة وإختصار آخر قد يكون متعارف عليه بين مهندسي البرمجيات ولكن البعض لايجيدون تطبيق المبدأ

You Aren’t Gonna Need It⚠️–
على الأقل في مراحل التطوير المبكرة في التطبيقات ، لأننا كمطورون نتطلع لمستقبل المشروع اللي بنشتغل عليه في الوقت الحالي ، فبالتالي قد يخطأ البعض في إضافة المزيد من ال Extra Features الغير ضرورية للمشروع واللي يظن البعض انها ضرورية في الوقت الحالي ولكن الحقيقة غير ضرورية على المدى البعيد للمشروع وقد تكون ضرورية في مراحل متقدمة في المشروع.
هذا المبدأ يندرج تحت مصطلح extreme programming (XP) والذي يشير إلى تنفيذ خطوات بسيطة التي تعمل وتُحقق الهدف منها ، وينتج عن تطبيق هذا المبدأ
✅ توفير المزيد من الوقت المُهدر في إضافة خطوات غير ضرورية
✅ المُضي في إستكمال المشروع بشكل كُفئ.
“Always implement things when you actually need them, never when you just foresee that you need them.”

Another acronym that’s popular among software engineers, YAGNI means “You Aren’t Gonna Need It”. This principle focuses on eliminating any unnecessary coding and works in tandem with the KISS principle.

– Sometimes, as developers, we try to think way ahead, into the future of the project, coding some extra features “just in case we need them” or thinking“we will eventually need them”. Just one word: Wrong! You didn’t need it, you don’t need it and in most of the cases… “You Aren’t Gonna Need It”.

YAGNI is a principle behind the extreme programming (XP) practice of “Do the Simplest Thing That Could Possibly Work”. Even when this principle is part of XP, it is applicable in all kinds of methodologies and processes of development. By implementing the ideals of “You Aren’t Gonna Need It” programming, you will save yourself time and be able to move forward with projects efficiently.

The KISS Principle

Ahmed Atef — Tue, 29 Mar 2022 09:46:48 +0000

وهو عبارة عن إختصار تم ملاحظته من قبل البحرية الأمريكية سنة 1960
Keep It Simple, Silly😀
واللي بيمثل بشكل كبير مايقوم به مجتمع مهندسي البرمجيات في عملهم ،
الفكرة ياعزيزي القارئ من وراء هذا المبدأ هو أن نحافظ على كتابة محتوى الكود البرمجي بمستوى دقيق قدر المستطاع.
وبتطبيق هذا المبدأ سينتج كود ذو معنى مفهوم وواضح ومُركز خالياً من التكرارات الغير لازمة ، وبكدا نقدر نتتبع الكود الخاص بنا بشكل سليم بدون إهدار للوقت وبذل مجهود كبير .

The popular acronym KISS, noted by the U.S. Navy in 1960, is extremely relevant in the software engineering community. It stands for “Keep It Simple, Silly” (some variations replace “Silly” with “Stupid,” but you get the idea). Whatever the variations, the underlying idea remains the same.

The keyword here is “Simple,” and the idea is to keep your code as concise as possible. In the context of coding, this means making your code meaningful, to-the-point, and avoiding unnecessary engineering work.

The KISS Principle ensures that your code has high maintainability. You should be able to go back and debug it easily, without wasting time and effort.