?Clean Code: Chapter 4️⃣ Comments
الكومنت في الاساس يعتبر code smell و مش حاجه كويسه تواجده في الكود بتاعك, و لكن لو كنت مضطر تكتب كوممنت لازم تبقي عارف كويس امتي و ازاى اكتب كومنت مفيد.
الكومنت في الاساس يعتبر code smell و مش حاجه كويسه تواجده في الكود بتاعك, و لكن لو كنت مضطر تكتب كوممنت لازم تبقي عارف كويس امتي و ازاى اكتب كومنت مفيد.
1. Always try to explain yourself in code.
اكتب كود يكون معبر عن نفسه, اللي يقرأه يفهم كويس هو بيعمل من غير ما يحتاج انك تكتبله كوممنت يشرحله و ده الاساس في كتابه اي كوممنت
اكتب كود يكون معبر عن نفسه, اللي يقرأه يفهم كويس هو بيعمل من غير ما يحتاج انك تكتبله كوممنت يشرحله و ده الاساس في كتابه اي كوممنت
2. Don't be redundant.
بلاش تكرر معلومه في الكوممنت واضحه في الكود زي انك تشرح function او property و هيه اسمها معبر اصلا
// this is the name of the employee
public string EmployeeName {get;set;}
بلاش تكرر معلومه في الكوممنت واضحه في الكود زي انك تشرح function او property و هيه اسمها معبر اصلا
// this is the name of the employee
public string EmployeeName {get;set;}
3. Don't add obvious noise.
بلاش تكتب كوممنت لمجرد انك تتكتب كومنت و خلاص و انك تقول علي كودك انه commented و ده اصلا مبدأ غلط
بلاش تكتب كوممنت لمجرد انك تتكتب كومنت و خلاص و انك تقول علي كودك انه commented و ده اصلا مبدأ غلط
4. Don't use closing brace comments.
بلاش الكومنت اللي في قفلة ال functions
public static void Main()
{
try
{
} //end try
catch(Exception e)
{
} // end catch
}//end Main
بلاش الكومنت اللي في قفلة ال functions
public static void Main()
{
try
{
} //end try
catch(Exception e)
{
} // end catch
}//end Main
5. Don't comment out code. Just remove.
مش محتاجه شرح ?
6. Use as an explanation of intent.
الكوممنت اللي بيشرح النية من عمل شئ معين او ايه الحكمة من اننا عملنا ال feature دي بالطريقة دي, و ممكن كمان لو حاجه مرتبطة ب issue قائمة , ممكن تحط github link علشان نعرف نتابعها
مش محتاجه شرح ?
6. Use as an explanation of intent.
الكوممنت اللي بيشرح النية من عمل شئ معين او ايه الحكمة من اننا عملنا ال feature دي بالطريقة دي, و ممكن كمان لو حاجه مرتبطة ب issue قائمة , ممكن تحط github link علشان نعرف نتابعها
6. Use as clarification of code.
لو خلاص حاولت كل اللي فوق و مهما عملت لسه الكود مش واضح كفاية للي بعدك , ممكن تستخدم الكوممنت للتوضيح
لو خلاص حاولت كل اللي فوق و مهما عملت لسه الكود مش واضح كفاية للي بعدك , ممكن تستخدم الكوممنت للتوضيح
7. Use as a warning of consequences.
استخدم الكوممنت كتحذير من شئ معين , يعني لو جزء اتحذف ممكن يأثر في النظام كله
استخدم الكوممنت كتحذير من شئ معين , يعني لو جزء اتحذف ممكن يأثر في النظام كله
جاري تحميل الاقتراحات...