هل التعليقات مفيد عن كتابة البرامج

يمنع الكتابة بالانجليزية في المنتي الا فى حالات معينة وتلك ليست منها

ارجو تعديل الموضوع وطرحه بشكل يتفق مع القوانين

تزتاد أهمية التعليقات بمرور الوقت كلما تعمقت فى البرمجة .

احيانا سطر من التعليقات يوفر عليك قراءة 100 سطر من الكود

عفوا اللغة التي كتب بها غير مفهومه رجاء قم بتعديلها ان استطعت...

الذي فهمة اهمية التعلقيات المكتوبه بالكود البرمجي..

بالطبع لهااهمية كبيره للمبرمج نفسه كي يعرف مافائدة الدوال والمتغيرات المكتوبه وما عملها ..

والي الاشخاص الذين يتتبعون البرنامج من بعدك .. اي بعد انتقالك من المؤسسة التي تعملها بها هذا على سبيل المثال..

من الطرق الحديثة

TDD

Test-Driven Development

كتابة الاختبارات قبل كتابة الكود البرمجي

مثلا تكتب مئة unit test ثم إذا نفذت الاختبارات يظهر لك 100 نتيجة حمراء

ثم كل ما تكتب الكود وتبني الفنكشنز تتحول النقاط الحمراء خضراء حتى تبني كامل النظام

المهم في الموضوع هنا: هو كتابة الunit test يغني كثيرا عن كتابة الكومنتس

لانك بمجرد قراءتك للـunit tests تعرف وظيفة الفنكشن وكيف تستخدم

يوجد درس في قسم الجافا عن JUnit أداة بسيطة جدا وصغيرة تساعدك على عمل ال unit tests

بالتاكيد اضافه التعليقات مهم، ولكن ليس اضافه التعليقات على كل سطر ليس له داعي مثلا اضافه تعليق على داله من نوع accessor ارى انه لا داعي له

الاهميه بالنسبه لي ترجع الى اني اكتب برنامج به مابين 10 لاى 30 ملف مصدري كما اني اقوم ببناء البرنامج بتصميم معين وافكار خاصه ولكن بعد فتره عندما اعود لقراءة برنامجي ارى انه من الافضل لي ان اكتب الكود من جديد

لذا فإن عمل documentation ممتاز مهم جدا في مسألة قراءة الكود وحتى جعله reusable وهذا مانراه في العديد من المكتبات الممتازه حيث ان ال documentation جيد لدرجه تغنيك حتى عن شراء الكتب لتعلمها

طبعا اقصد بالdocumetnation الملاحظات comments و دليل الاستخدام manual ولكن في الوقت الحالي يمكنك بناء manual عبر استخدام الdocumetation comments كما في جافا وسي شارب

تحياتي

صراحة وعن تجربة أرى أنه من الضروري كتابة التعليقات

لأنك سوف ترجع إلى برنامجك بعد ستة أشهر فإن لم يكن به تليقات فلن تفهمه إلا بشق الأنفس فمابالك بغيرك

اعتقد ان التعليقات خارج نطاق البرمجة تماما ً

من وجهت نظري التعليقات ليس مجرد كلمات نضعها فوق الكود بل هي فن اختيار الكلمات المناسبة في المكان المناسب لتعطي ملخص كامل عن الكود

واعتقد ان هذا الفن لا يتقنه الكثيرين , فكونك مبرمج لا يعني انك فنان في كتابة التعليقات ,

احيانا ً ارى في بعض البرامج هذا التعليق او مايشابهه

if( a == 5 ) // if a equal 5

صراحه تحس ان المبرمج ماشاء الله ذكي في هذا التعليق :lol:

اعتقد لا بد من وجود دروس وكورسات تشرح فن التعليق على الكود ^_^

M.B.O كتب:

اعتقد ان التعليقات خارج نطاق البرمجة تماما ً

من وجهت نظري التعليقات ليس مجرد كلمات نضعها فوق الكود بل هي فن اختيار الكلمات المناسبة في المكان المناسب لتعطي ملخص كامل عن الكود

واعتقد ان هذا الفن لا يتقنه الكثيرين , فكونك مبرمج لا يعني انك فنان في كتابة التعليقات ,

احيانا ً ارى في بعض البرامج هذا التعليق او مايشابهه

if( a == 5 ) // if a equal 5

صراحه تحس ان المبرمج ماشاء الله ذكي في هذا التعليق :lol:

اعتقد لا بد من وجود دروس وكورسات تشرح فن التعليق على الكود ^_^

هل أنت جاد بما تقوله؟

kiubo كتب:

هل أنت جاد بما تقوله؟

ربما ....

التعليقات مهمة جداً و لكنها كأي شئ يمكن إساءة استخدامها احد اهم استخدامات التعليقات

1. وضع رخصة الاستخدام و حقوق المكية فوق كل ملف
   
2. قبل كل كلاس نبذة عن ما الهدف منها
   
3. قبل كل دالة خاصة الpublic نبذة عنها و ماهي الافتراضات التي تفترضها هذه الدالة على مدخلاتها مثلا لو كانت تقبل متغيرات رقمية هل القيمة 0 صحيحة او السالب صحيح و هكذا
   

هناك أيضاً حالات خاصة عند كتابة بعد الخطوات في الكود و التي تكون معقدة بعض الشئ يمكن وضع شرح بسيط عن ما الذي يحدث

البرنامج الذى لا يحتوى على شرح للأجزاء المهمه به سيموت قبل أن يولد.

بالفعل لا غنى عن التعليقات و قد مررت بتجارب مريرة مع برمجيات لم تكن ثرية بالتعليقات الكافية.