علة عدد التعليقات
https://stackoverflow.com/questions/163232
-
03-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russianسؤال
لماذا تضيف
//علة 1024
التعليقات إلى مصدر التحكم رمز القاعدة ؟ معظم الأخطاء وتتبع مصدر أنظمة التحكم بشكل أفضل equipted لتتبع هذه المعلومات.في عنصر تحكم مصدر التسمية أو تعليق يمكن استخدامها مع الاعارة.في تعقب علة تنقيح عدد يمكن أن تضاف إلى علة هذا القرار.فلماذا التعليق الرمز ؟ خاصة منذ هذه التعليقات أهميتها جدا قصيرة وأنها تميل إلى أن تتراكم القمامة رمز قاعدة.
المحلول
ولقد وجدت واحدة من هذه مفيدة في ذلك اليوم في قاعدة رمز لنا.
وقلت: "لماذا هو استدعاء الدالة التهيئة للمرة الثانية، وهذا في وقت متأخر من سير العمل ؟؟"
والتعليق علة اسمحوا لي أن يسير في الاتجاه الصحيح وصف القضية. عندما كنت إعادة تجهيزها رمز، وأنا على يقين من أن تدرج هذا الخطأ في بلدي التجارب ولم إعادة إدخاله.
وعلى الرغم من أنني لن أقول أنه في عام وأنا أتفق معك ولا إدراج تلك نفسي.
وكنا نفضل أن المطور في مسألة إصلاح الأخطاء في طريقة أكثر وضوحا، لدرجة أنني لم يكن لديك ما يدعو للقلق التعليمات البرمجية في المقام الأول.
نصائح أخرى
وأخيرا، أعتقد أنه من عادة سيئة. فمن الأفضل أن تشمل السبب وجود خلل (فوس من نوع Y لا تملك Z الملكية). يمكنك تضمين "أكثر في BUGID 12345" جنبا إلى جنب مع أنه إذا كنت تريد.
إذا كنت دمج على مستويات متعددة، وطريقة عرض التعليمات البرمجية المصدر في تراك يمكن ربط مباشرة إلى BUGID.
والكسل الصرفة. بالتأكيد، فإنه يأخذ المزيد من الوقت على المدى الطويل، ولكن على المدى القصير "// علة 1024" يأخذ أي جهد على الإطلاق. لمزيد من رموز لديك، والأسوأ من ذلك هو.
وتخيل لديك علة الجديد الذي قمت تعقب التغير في مراجعة 12345. أن تبحث في السجلات وعلى الفور يخبرك أن علة كان 1024 السبب تم إجراء التغيير.
ويمكنك بعد ذلك اذهب وابحث في 1024 لنرى ماذا ولماذا ومتى قبل اتخاذ أي إصلاح جديد - في "واحد إلى حكم عليهم جميعا '
وإذا كان عدد الأخطاء ليست في الرسالة ارتكابها، لديك ثم للبحث عن الأخطاء التي وكرست ثابت - والتي قد تكون عدة (إذا كان يحصل على الإبلاغ عن الأخطاء أكثر من مرة)
.وأنا أعتقد أن هذا هو حال "لدي المطرقة، والتي يجب أن تكون مسمارا". محرر النص الخاص بك أو IDE ليست الأداة الوحيدة لديك لإدارة التعليمات البرمجية.
ومن الأفضل الحفاظ على التاريخ خارجيا إلى رمز. ينبغي أن توصف معنى الرمز في تصريحات عندما لم تكن واضحة على الفور.
وأنا أتفق يجب أن تكون أن أرقام خطأ في التحكم بالمصادر تلتزم الرسائل.
ويجب عليك أبدا مجرد إضافة رقم الخطأ. يجب عليك إضافة عدد الشوائب وهذا الموضوع، وأي تصفيات إذا أجريت عمليات الوصول متعددة لعلة واحدة:
وعلة 1111 - ضبطت فو على أنظمة 64BIT. إصلاح # 2 لأن أعيد افتتاحه بعد الدمج إلى الجذع.
وبعض النظم والتكامل عدد الشوائب. في mxr.mozilla.org عدد خطأ في السير الذاتية تسجيل والسيارات سحرية تحول العرض إلى وجود صلة لعدد bugzilla.mozilla.org. عند حفر في قانون، وهذا هو مرة المنقذ ضخمة. أعتقد أن Fogbugz لديها ميزة مشابهة ...
وأيضا، حتى إذا كان جهازك لا، فإنه غالبا ما يساعد لأن لا أحد يريد أن يرى سياق كامل من التغيير في تصريحات، وهذا هو ما هو تعقب علة ل.
وأود أن أتفق معك أن تعليق مثل هذا ليس حقا مفيدة وغير وجيزة جدا.
غير أنه من المفيد للغاية ومهم التعليق رمز مع إشارات إلى السجلات في عيوب نظام تتبع (أو إلى أن تمتد إلى أي مستودع KM قد يكون لديك).
وأحيانا يتم تغيير رمز لتنفيذ حلا لقضية معينة مع سلوك التطبيق. أحيانا الحل عرضه في أي وسيلة منطقية. وغالبا ما يحدث ذلك عندما يتم تحديث رمز من قبل شخص آخر يتم إزالة هذه القطعة 'سيئة' من التعليمات البرمجية كجزء من جهود إعادة العوملة.
وهكذا بمناسبة رمز على أنها تنتمي إلى معين علة الإصلاح يجعلها مرئية خلال إعادة بيع الديون، مما دفع المطور لمراجعة وصف علة قبل تغيير التعليمات البرمجية. كما أنه يساعد في الحالة التي تكون فيها اعادة فتح علة - إذا كان لديك لتغيير نفسه جزءا من القانون عدة مرات قد تفكر في استثمار الوقت في حل بديل
وP.S. هل يمكن أن تنظر هذه المقالة حول Office MS من جويل في البرامج مفيدة. وبقدر ما أعرف رمز من مايكروسوفت أوفيس ومايكروسوفت ويندوز هو الكامل من تصريحات مماثلة التي تفسر القرارات التي اتخذت من قبل المطورين انتهت منذ فترة طويلة.
وأجد أنه من المفيد عندما شرح التعليمات البرمجية التي يبدو خلاف ذلك الخطأ، وأيضا لاستخدامها في ارتكاب الرسائل.
أنا لا أفعل ذلك.لا يمكنني التفكير في سبب وجيه لماذا وضع عيب معرف في القانون.أنا وضعت ذلك على ملاحظات الإصدار/التغيير بدلا من ذلك.
ما أجده مفيدا يستخدم عيب الهوية كجزء من الاسم على الاختبارات التلقائية:
[TestFixture]
public class Release_1_2_Bugfixes
{
[Test]
public void TestBug42()
{
Assert.AreEqual(42, CalculateAnswerToLifeUniverseAndEverything());
}
}
رأيت مشاريع أخرى تفعل الشيء نفسه.
وأنا استغرب كيف كثير من الناس يعارضون ذلك. شعوري الشخصي في هذا هو أن هذه هي غاية <م> جيدة الفكرة. وأنا أتفق مع تعليق سابق أنه ينبغي أن تشمل أكثر من مجرد رقم الخطأ، وتشمل يفضل ملخص قصير وصلة لنظام تتبع الأخطاء إذا كان ذلك مناسبا.
والفائدة على هذه التعليقات واضحة فقط في مشروع قديمة مع التاريخ وعدد كبير من الاصلاحات السابقة. لم يكن لديك لجعل هذه التعليقات في كل مكان، لكنها مفيدة جدا جدا عندما وضعت قبل كتلة من التعليمات البرمجية التي قد لا يكون له معنى بدون إطار. في أي نوع من نظام معقد إلى حد معقول، سيكون هناك قصاصات من التعليمات البرمجية التي يبدو غير منطقي أو غير ضرورية دون السياق.
ونظرا للتفاعلات مع النظام أو الحلول القديمة، رمز <م> هو ضروريا. من أجل منع أي شخص بعد العودة للعلة مصححة، انها مفيدة للغاية للدلالة على علة تم تصميم كتلة التعليمات البرمجية لإصلاح، ويفضل مع بعض نوع من التفسير المرفقة. وإلا كنت اعتمادا على شخص التحقق من تاريخ ارتكاب بعناية لسبب المسجلة في ارتكاب السجل، وهو أمر مستبعد للغاية، خاصة إذا كان شخص ما كود إعادة بيع ديون.
تعديل : لانا مشيرا بالتحديد إلى وضع هذه مع كتلة من التعليمات البرمجية التي هي غير عادية أو يحتاج سياق إضافي. انها ليست مفيدة أو ضرورية للتعليق كل إصلاح الخطأ المطبعي واحد جعل لكم: -)
وفعلت ذلك حتى البصرية ستوديو 2008 التي يتم شحنها مع الشرح. ومن المفيد عندما ننظر الى الوراء على القانون القديم لنرى على الفور أن هناك على الأقل كان يعتقد وراء قرار كود معين.
ونعم، وأنا أعلم أنك تستطيع أن تفعل مقارنة مع الإصدارات السابقة، ولكن هذا هو مثل هذا الألم في بعقب عندما كنت بحاجة فقط سريع أشعر أنني بحالة جيدة حول التحديثات كود طفيفة.
إذا كنت أتصفح شفرة المصدر غير مألوف، وكنت ترى شيئا غير واضح، أنه من الجيد أن نعرف السبب. انها دعوة الحكم رغم ذلك، ليس كل علة يحتاج مثل هذا التفسير - ربما أكثر يمكن أن تفلت من دونه
إذا كان هناك سببا كافيا للاعتقاد بأن شخص ما تريد أن تعرف عدد الأخطاء عند النظر في جزء من القانون، إضافة تعليق بالذكر علة يمكن أن يكون لطيفا جدا (اتمنى ان اعادة صياغة بت هامة من الأخطاء أيضا، ومع ذلك).
نعم، التحكم بالمصادر تلزم يجب أن تحتوي الرسائل أيضا الأرقام علة، ويمكن النظر من خلال سجلات مراجعة تعطيك نفس المعلومات ... ولكن إذا تم تغيير نفس الجزء من القانون عدة مرات، ولكن تفاصيل المستفادة من علة الأولي لا يزال ساريا، قد يستغرق بعض الوقت للعثور التغيير الأصلي لمعرفة من أي وقت مضى حول هذا الخطأ.
وبالإضافة إلى ذلك، تنشأ حالات عندما يكون هناك سبب وجيه لنقل رمز من فئة واحدة إلى أخرى، أو لإعادة تسمية الملفات، والتي من شأنها أن تجعل من الصعب حتى للعثور على جذر السبب وراء قسم معين من التعليمات البرمجية (إعادة تسمية ليس كذلك بكثير من قضية مع SVN، ولكن الألم مع CVS).
وأنت أصاب كبد الحقيقة على رأسه "وعاش صلة قصيرة جدا وأنها تميل إلى بناء المنتشرة في قاعدة التعليمات البرمجية."
وكل شيء من العناصر غير المرغوب فيها عديمة الفائدة التي تتراكم في ملفات مصدر يجعلها أقل قليلا للقراءة ويصعب الحفاظ عليها. حذف كل ما لا يضيف قيمة. "12345 الشوائب" له قيمة تذكر الآن، وسوف يكون لا شيء في غضون بضعة أسابيع.
ونحن نعمل على نظام واسع النطاق مع العديد من المطورين وفروع سراح متعددة.
وهذه التعليقات علة إشارة يمكن أن يكون في الواقع مفيدة جدا أثناء ترقية من فرع واحد إلى آخر وخصوصا ان نظام SCM التي نستخدمها جدا ميزة الفقراء وارتكاب تعليقات من الصعب الحصول على أو ويمكن أن تكون قديمة جدا.
إذا كان الإصلاح بسيط ومن ثم قد لا تحتاج إلى علامة الشوائب. وإذا كان من غير الواضح أنه قد يكون أكثر منطقية للإشارة إلى علة ثم لكتابة شرح طويل في قسم التعليق.
ولم يعجبني هذا النوع من الكتابة على الجدران. مثل أشكال الحياة الأخرى التي كريه ملتحم مع مرور الوقت، والاختناق قانون الأساس.
ولكن المشكلة تبدأ حقا عندما تجعل الناس الاصلاحات التي تتداخل إصلاح الأخطاء السابقة. ثم لديك أرقام الأخطاء وصفها قسم من التعليمات البرمجية التي هي ببساطة خاطئة أو مضللة.
وهذا النوع من يعلق <م> هو مفيدة جدا: ما يحدث عند تغيير علة تتبع أو أدوات التحكم بالمصادر؟ ومن شأن الإشارة إلى BZ1722 مقابل FB3101 اقول لكم ما أداة تتبع للتحقق من (بجزيلا أو FogBugz على سبيل المثال).
وإنه لأمر جيد!
والشخص الذي يبحث في التعليمات البرمجية غير المرجح أن نقدر التاريخ الكامل للقانون، ومن المرجح أن التراجع عن تغيير مهم جدا لأنها قد لا يعمل في هذا المجال من قانون من قبل. ويمكن تفسير التعليمات البرمجية التي تبدو خلاف ذلك مجنونا أو شرط العملاء التي هي غريبة مكافئ.
وأنت لا يمكن دائما التقاط تفاصيل دقيقة لمتطلبات العملاء من خلال الهندسة المعمارية ورمز، وخاصة عندما تسأل عن شيء غبي. وبالتالي عليك أن تبدأ مع العاقل ثم صقل أو الإختراق الشفرة في غبي عندما كنت اضطر للقيام بذلك، وأرقام الأخطاء احتياطية القصد من قانون مجنون.
