20 বছরের স্থায়ী সফটওয়্যার ইঞ্জিনিয়ার হিসাবে, বেশিরভাগ সুরক্ষা সম্পর্কিত জিনিসগুলিতে কাজ করে (এসএফ-পিডি), আমাকে বলতে হবে যে আপনার বস সেই ব্যক্তিকে আপনার উদাহরণ হতে পারে না। মন্তব্যের অভাব হ'ল স্ব-শিক্ষিত অপেশাদার কোডার, যিনি কখনই সঠিকভাবে কাজটি করবেন তা শিখেননি বা কোনও অনভিজ্ঞ ইঞ্জিনিয়ার a অথবা সম্ভবত এমন কোনও প্রকৌশলী যার কাছে কেবল সময় নেই - সময়সীমা এবং সময়সীমা আপনার কোডটিতে ভয়াবহ কাজ করতে পারে! ;) এটি অবশ্যই প্রতিটি সক্ষম সফ্টওয়্যার ইঞ্জিনিয়ারের জন্য একটি বিরোধী-নিদর্শন।
আপনার বস খুব ভাল কোডার হতে পারে, তবে মনে হচ্ছে তিনি কোনও ভাল সফটওয়্যার ইঞ্জিনিয়ার নন। একজন প্রকৌশলী অন্যান্য লোকেরা ইতিমধ্যে ধরা পড়েছে এমন সমস্যাগুলি এড়াতে সম্মিলিত গ্রুপের অভিজ্ঞতা ব্যবহার করে। কার্যকর মন্তব্যটি সফ্টওয়্যারটির জন্য সেই সমষ্টিগত গ্রুপের অভিজ্ঞতার অংশ, একইভাবে স্ট্রেস বিশ্লেষণ যান্ত্রিক ইঞ্জিনিয়ারিংয়ের জন্য সম্মিলিত গ্রুপের অভিজ্ঞতার একটি অংশ। কার্যকর মন্তব্য হিসাবে যা বিবেচনা করা হয় তা আরও তরল, এবং এটি অবশ্যই আপনার অভিজ্ঞতা থেকে পাওয়া।
সর্বাধিক প্রাথমিক জিনিসটি মন্তব্যগুলির একটি লাইনের কোডের কি করে তা বলা উচিত নয়। এমন সময় রয়েছে যখন কোনও ফাংশন কী করে তা মন্তব্য করার জন্য অতিরিক্ত অতিরিক্ত হয় (বিশেষত সি #)। অতিরিক্ত মন্তব্য করা ঠিক ততটাই অকার্যকর হতে পারে (এবং অভিজ্ঞতার অভাবে একটি পয়েন্টার) কারণ আপনি শ্রাবন্তে গুরুত্বপূর্ণ জিনিসগুলি খুঁজে পেতে পারেন না। নবজাতক হিসাবে, আপনি এখনও কোডটির "কী" সন্ধানের জন্য কাজ করছেন এবং তার জন্য আপনাকে কেবল তিনি কী করেছেন তা পড়তে এবং বুঝতে হবে।
মন্তব্যের জন্য গুরুত্বপূর্ণ বিষয় যদিও তারা বলে যে কেন কোডের একটি লাইন বা একটি ফাংশন এটি কী করে, যেখানে এই সুস্পষ্ট নাও হতে পারে। মডিউল ওয়াইয়ের আগে আপনার কি মডিউল এক্স সেট করা দরকার? কোনও ফাইল ইতিমধ্যে খোলা ছিল কি না তা দেখার জন্য কি কোনও রিটার্ন কোড পরীক্ষা করা গুরুত্বপূর্ণ, বা এটি অন্য কোথাও চেক করা হয়েছে বলে আমরা সচেতনতার সাথে রিটার্ন কোডটিকে অগ্রাহ্য করছি? কোডটির "কেন" অভিজ্ঞতা নির্বিশেষে সকলের জন্য প্রাসঙ্গিক হবে - এবং 6 মাসের মধ্যে এটি তার সাথে প্রাসঙ্গিক হবে, যখন তিনি কোনও নির্দিষ্ট উপায়ে কিছু করার ভাল কারণটি ভুলে যান। মন্তব্য করা কেবল অন্য মানুষের জন্য নয়, এটি ভবিষ্যতে আপনাকে সহায়তা করার জন্যও।
আপনি যদি নিজের বসকে বিরক্ত করতে না চান তবে স্মার্ট প্রশ্ন জিজ্ঞাসা করুন। "কেন" সম্পর্কে জিজ্ঞাসা করার দিকে মনোনিবেশ করুন এবং নিজেকে "কী" সম্পর্কে কাজ করার চেষ্টা করুন (যদি না এটি সত্যই অস্পষ্ট না হয়)। আর-ইনফিং টিএফএম থেকে আপনি যে ধরণের জিনিস খুঁজে পেতে পারতেন তা যদি না হয় তবে কোনও ভাল বসকে প্রশ্ন জিজ্ঞাসা করতে আপত্তি করবে না। এবং কোনও ভাল ইঞ্জিনিয়ারকে এমন কিছু করতে বলা হবে না যা তাদের জন্য সামান্য ব্যয় করে অন্য ইঞ্জিনিয়ারের জীবনকে উল্লেখযোগ্যভাবে সহজ করে তুলবে। (কেবলমাত্র পুরো কোডবেসে মন্তব্য ব্যাকফিল করার জন্য তাকে জিজ্ঞাসা করবেন না ;;)