আমি একটি প্রকল্প ছেড়ে চলে যাচ্ছি, এবং যাওয়ার আগে আমার বস আমাকে কোড ডকুমেন্ট করতে বলেছেন (আমি খুব ভালভাবে নথিভুক্ত করি নি)। এটি কোনও বড় বিষয় নয়, প্রকল্পটি খুব জটিল নয়। তবে আমি আমার ডকুমেন্টেশনে এমন জায়গাগুলি সন্ধান করছি যেখানে আমি বলতে চাই, "এক্সওয়াইজেড লাইনে নোটিশ করুন যে এই ধরণের ঘটেছিল।"
এই ক্ষেত্রে, কোনও নির্দিষ্ট লাইন নম্বর উল্লেখ করা কোনও অর্থবোধ করে না, যেহেতু একটি একক লাইন কোড যুক্ত করা বা মুছলে তা ডকুমেন্টেশনকে পুরানো হয়ে যায়। লাইন সংখ্যা দ্বারা উল্লেখ না করে কোডের নির্দিষ্ট লাইনটি উল্লেখ করার জন্য কি কিছু সেরা অনুশীলন রয়েছে?
আমি কোডটি লিটারে লিখিত মন্তব্য সহ বিবেচনা করেছি:
/* linetag 38FECD4F */
যেখানে "38FECD4F" নির্দিষ্ট রেখার জন্য কিছু অনন্য ট্যাগ। তারপরে আমি ডকুমেন্টেশনটিতে রাখতে পারি, "'38FECD4F' ট্যাগ করা লাইনে, লক্ষ্য করুন যে এ জাতীয়-তেমন ঘটনা ঘটে।"
অন্য কোন ধারণা? আমি মনে করি সাধারণত কোড ইউনিটগুলির নির্দিষ্ট অংশগুলির চেয়ে পুরোপুরি নথিভুক্ত করা ভাল, তবে এই বিশেষ প্রকল্পের ক্ষেত্রে প্রসেসরিজাল কোডগুলির দীর্ঘ সোয়াথ রয়েছে, যা কখনও কখনও ছোট ইউনিটগুলিতে প্রতিস্থাপন করা হয়নি।