পুরানো মন্তব্যগুলি কি একটি শহুরে মিথ?


38

আমি প্রতিনিয়ত লোকেরা দাবি করে দেখি যে "মন্তব্যগুলি পুরানো হয়ে যায় to" কথাটি হ'ল, আমি মনে করি আমার পুরো ক্যারিয়ারে সম্ভবত দু'ত তিনটি পুরানো মন্তব্য দেখেছি। পৃথক নথিতে পুরানো তথ্য সর্বদা ঘটে থাকে, তবে আমার অভিজ্ঞতায় কোডের মধ্যে পুরানো মন্তব্যগুলি অত্যন্ত বিরল।

আমি কার সাথে কাজ করছি তার মধ্যে আমি কি ভাগ্যবান হয়েছি? নির্দিষ্ট শিল্পগুলি কি অন্যদের চেয়ে এই সমস্যায় বেশি ঝুঁকিপূর্ণ? আপনি যে সাম্প্রতিক কালীন মন্তব্যগুলি দেখেছেন তার নির্দিষ্ট উদাহরণ রয়েছে? না কি পুরানো মন্তব্যগুলি একটি বাস্তবের চেয়ে তাত্ত্বিক সমস্যাটির বেশি?


30
একমত। পুরানো কোডটি একটি মন্তব্যে পরিণত হয়েছে, এখন এটি এমন কিছু যা আমি অনেক দেখি - এবং এর চেয়ে কম দেখতে চাই।
পাইভি

8
আমি কোনও কিছুর চেয়ে কমেন্টের বেশি অভাব দেখতে পাচ্ছি। দুর্বল নামকরণের সম্মেলনের সাথে একত্রিত হয়ে আমি কাজ করি এমন কিছু জিনিস পড়ার চেষ্টা করে মজাদার একটি বল।
পি। ব্রায়ান.ম্যাকি

2
আমি প্রচুর পুরানো মন্তব্য দেখেছি, কিছু ছিল কেবল বিভ্রান্তিমূলক ILভিল। অবশ্যই কোনও পৌরাণিক কাহিনী নয়, তবে বেশিরভাগ লোকেরা এবং / অথবা দীর্ঘকাল ধরে জটিলতার দ্বারা প্রশস্ত করা প্রকল্পগুলির জন্য বেশিরভাগই বৈধ। তবে আমি কোডটি বিশ্বাস করতে শিখেছি, মন্তব্যগুলিতে নয় (তারা প্রায় দুটি কখনই পড়তে পারে না যদি তারা একটি দুটি লাইনের বেশি হয়)।
মার্চ

আমি পুরো আমার পুরো ক্যারিয়ার জুড়ে বেশিরভাগ পুরানো লিগ্যাসি কোড নিয়ে কাজ করছি। প্রায় এক ডজন বার হয়েছে যখন আমি 30 বছরের পুরনো ফর্টান 7777 কোডটিতে পুরানো মন্তব্য সম্পর্কিত কিছু গুরুতর সমস্যা পেয়েছি, তবে মন্তব্যগুলি পর্যাপ্ত ছিল যেখানে কোডটির শূন্য শতাংশের কাছাকাছি ছিল। সুতরাং আমি একমত, কোনও সমস্যার স্কেল অবশ্যই অতিরঞ্জিত করা উচিত।
এসকে-লজিক 10

আমার ভাগ্য, আমি পোস্ট করার পর থেকে বছরে বেশ কয়েকজনকে দেখেছি। আমার ধারণা আমি অবচেতনভাবে তাদের দীর্ঘস্থায়ী স্মৃতিতে রাখার জন্য পর্যাপ্ত চিন্তা না করে তাদেরকে বিশ্বাস না করা, তারপর সেগুলি সংশোধন করতে এবং এগিয়ে যেতে শিখেছি।
কার্ল বিলেফেল্ড

উত্তর:


33

প্রতিনিয়ত

আমি সত্যই বিশ্বাস করতে পারি না আমি পুরানো এবং বিভ্রান্তিকর মন্তব্যে একমাত্র সাঁতার কাটছি। অফ সুযোগটিতে এটি বুঝতে সহায়তা করে:

এটি সম্ভবত কোড বয়সের উপর সবচেয়ে গুরুত্বপূর্ণভাবে নির্ভর করে। পরবর্তী ফ্যাক্টরটি কর্মীদের উপর টার্নওভার হবে।

আমি সমান অংশ গবেষণা ও উন্নয়ন এবং রক্ষণাবেক্ষণের কাজ করি। আর অ্যান্ড ডি হ'ল নতুন কোড, সাধারণত এমন জিনিস যা পিটানো পথ থেকে কিছুটা দূরে। আমার অনেক সহকর্মী এমন কিছু চেষ্টা করার সময় প্রচুর মন্তব্য ব্যাখ্যা করার বিষয়ে বিশ্বাস করে যা ইতিমধ্যে সেখানে কোনও লাইব্রেরি নেই। কোড অনুপাতের মন্তব্য স্বাভাবিকের চেয়ে বেশি হওয়ায় জিনিসগুলি সিঙ্কের বাইরে চলে যাওয়ার আরও বেশি সুযোগ রয়েছে।

রক্ষণাবেক্ষণের কোড ... আমি 10 বছরেরও বেশি পুরানো সিস্টেমের একজন সক্রিয় রক্ষণাবেক্ষণকারী এবং অন্যরও 5 বছরের বেশি The 10 বছরেরও বেশি সময় আপনি কোডবেসে প্রচুর হাত পেয়েছেন এবং পুরো জিনিসটি কীভাবে কাজ করে তা কারওই ধারণা নেই। 5 বছরের পুরানো কোড এবং মন্তব্যগুলি বেশ ভাল কারণ টিমের টার্নওভারটি খুব কম।

আমি প্রায় সমস্ত পরিষেবা কাজ করি, এমনকি আমাদের পণ্যগুলি একটি নির্দিষ্ট গ্রাহকের কাছে অত্যন্ত কাস্টমাইজ করা হয়।

নির্দিষ্ট উদাহরণ:

  • কোনও নির্দিষ্ট পদ্ধতিটির জন্য পারফরম্যান্স উন্নতির বিবরণ দেওয়া মন্তব্যগুলি যেমন মেমরির অনুলিপি এড়ানো। পেন্টিয়াম 2 এ এমবি র‌্যাম সহ একটি শীর্ষ এন্ড মেশিন, তবে এখনই সমস্যা now

  • todos

  • মন্তব্য সহ অনুলিপি-অনুলিপি কোড। মন্তব্যটি তার আসল অবস্থানটি বোধগম্য হতে পারে, তবে এখানে খুব কমই বোঝা যায়

  • মন্তব্য করা আউট কোডের শীর্ষে মন্তব্য ব্লক (কে জানে যে সেখানে কত বছর হয়েছে)।

এই সমস্ত ক্ষেত্রে আপনি কেবলমাত্র সফ্টওয়্যার হিসাবে একই স্তরের মন্তব্য এবং কোড বজায় না রাখার একটি প্রবণতা দেখতে পান। আইডিই এবং বেসিক বিকাশকারী অভ্যাসগুলি এতে সহায়তা করে না, আমার চোখ এগুলি গত করার প্রশিক্ষণ দেওয়া হয়েছে। আমি মনে করি সবুজ ক্ষেত্র এবং সক্রিয় প্রকল্পগুলিতে মন্তব্য পুরানো-নেস তুলনামূলকভাবে সস্তা। আপনি যদি কোড / মন্তব্য অনুপাতকে বেশি রাখতে পারেন তবে তাদের আপ টু ডেট রাখাই বড় বিষয় নয়। আপনি যখন কোনও প্রোডাকশন সিস্টেমে বাগ ফিক্স করার জন্য x ঘন্টা বাজেট করেন তখন এই জিনিসগুলি শিকারের পক্ষে যুক্তিযুক্ত হওয়া একটু কঠিন।


সুতরাং মূলত আপনি বলছেন যে আপনি কেবল মন্তব্যগুলি পুরোপুরি উপেক্ষা করুন কারণ এটি ইতিমধ্যে আপনার গণ্ডগোলের থেকে অনেক বড়, কেবল আপনার পরিস্থিতি আরও খারাপ করে তুলেছে। এতে বিস্মিত হবার কিছু নেই.
স্টিভেন জিউরিস 16

5
@ স্টিভেন - আমাকে ব্যক্তিগতভাবে, না। আমি ইনক্রিমেন্টাল উন্নতিতে একজন বড় বিশ্বাসী। আমি দেখেছি সম্পূর্ণ অনিবার্য কোডের স্নারেলগুলি যথেষ্ট ধীরে ধীরে প্রচেষ্টার সাথে বেশ কিছু শালিনে পরিণত হয়েছে। তবে, উপেক্ষা করা অবশ্যই আমার অভিজ্ঞতার আদর্শ। ক্যাটালগের কয়েক সপ্তাহ মূল্যমানের সমস্যা সহ আপনি যখন বেশ কয়েকটি আন্তঃসংযুক্ত 10000 লাইন ক্লাসের মুখোমুখি হন তখন এটি খুব বোধগম্য হয়, যে পুরানো মন্তব্যগুলি অগ্রাধিকার তালিকার নীচে চলে যায়।
স্টিভ জ্যাকসন

1
@ স্টিভ: আপনার পরিস্থিতিতে আমি কেবল একটি স্ক্রিপ্ট তৈরি করব যা তখন সমস্ত মন্তব্য মুছে ফেলে এবং যেখানে প্রয়োজন সেখানে স্ক্র্যাচ থেকে মন্তব্য করা শুরু করবে। :)
স্টিভেন জিউরিস

1
প্রধান কোড বেস যেখানে আমি কাজ করতাম তা ছিল কমপক্ষে অর্ধেক মন্তব্য এবং খুব কমই মন্তব্য করা কোড। পুরানো মন্তব্যগুলি জীবনের সত্য ছিল, সঠিক মন্তব্যগুলি অত্যন্ত বিরল ছিল এবং আমি ডকুমেন্টেশনেও মন্তব্য করতে শুরু করব না !!! দর্শন ... এই কাজের পরে আমি শিখেছি যে কম ভাল, যদি আপনার কোডটি মন্তব্য করার প্রয়োজন হয় তবে বিষয়গুলিকে আরও সুস্পষ্ট করে তোলার জন্য সম্ভবত এটি একটি রিফ্যাক্টর প্রয়োজন ...
নিউটোপিয়ান

4
এর কয়েকটি ভয়াবহ উদাহরণ আমি দেখেছি Blocks of copy-pasted code including comments. Comment may have made sense in its original location, but hardly makes sense here। উদাহরণস্বরূপ, শ্রেণি-স্তরের মন্তব্যগুলি একটি পৃথক শ্রেণীর কথা বলে।
পিটার টেলর

18

"মন্তব্যগুলি পুরানো হয়ে যায়" "

আমি প্রায়শই এটি ঘটতে দেখেছি এটি জানতে সমস্যা হতে পারে enough

কথাটি হ'ল, আমি মনে করি আমার পুরো ক্যারিয়ারে সম্ভবত দু'ত তিনটি পুরানো মন্তব্য দেখেছি।

আমি বিশ্বাস করি যে এমন পরিবেশে কাজ করা পুরোপুরি সম্ভব হওয়া উচিত যেখানে প্রত্যেকে মন্তব্যগুলির যথেষ্ট যত্ন নেয় এবং সেগুলি বজায় রাখে। আপনি যে কোডটি সম্পাদনা করছেন তার নিকটবর্তী মন্তব্যগুলি দেখার এবং উপযুক্ত হলে সেগুলি আপডেট করার জন্য এটি একটি ছোট্ট অতিরিক্ত প্রচেষ্টা effort যদি মন্তব্যগুলি এত দূরে থাকে যে আপনি তাৎক্ষণিকভাবে সেগুলি লক্ষ্য করবেন না, সেগুলি যাইহোক খারাপ মন্তব্য ছিল এবং এটিকে প্রথমে যুক্ত করা উচিত হয়নি (বা কমপক্ষে সেখানে নেই)।

তদ্ব্যতীত মন্তব্যগুলি পুরানো হয়ে ওঠার প্রবণতার পাশাপাশি সাধারণত বিবৃতি অনুসরণ করে যে এটি পাঠযোগ্যতা হ্রাস করে এবং মানুষকে বিভ্রান্ত করে। এটি এমন কিছু যা আমি এখনও অভিজ্ঞতা লাভ করি নি। যতবারই আমি কোনও তারিখের বাইরে থাকা মন্তব্যের মুখোমুখি হই, আমি স্পষ্টভাবে কী পরিবর্তন করেছি এবং কিছু অতিরিক্ত প্রচেষ্টা সত্ত্বেও নতুন কোডটি উপস্থাপন করতে সেই অনুযায়ী মন্তব্যটি আপডেট করেছি।


রোহম এট আল এর সাম্প্রতিক গবেষণা 2012 নিম্নলিখিত পর্যবেক্ষণ:

২১ জন অংশগ্রহণকারী [২৮ জনের মধ্যে] জানিয়েছেন যে তারা সোর্স কোড এবং ইনলাইন মন্তব্যগুলি থেকে তাদের মূল তথ্য পেয়েছে কেবল মাত্র চারজন জানিয়েছেন যে ডকুমেন্টেশন তাদের তথ্যের মূল উত্স।

এটি আপনার সন্দেহের সাথে সামঞ্জস্যপূর্ণ যে কোডটিতে সাধারণত মন্তব্যগুলি এখনও খুব দরকারী বলে বিবেচিত হয়। এটি ইঙ্গিত দেয় যে পুরানো ডকুমেন্টেশন এবং পুরানো মন্তব্যগুলির মধ্যে একটি স্পষ্ট লাইন আঁকতে হবে

রোহম, টি।, টিয়ার্কস, আর।, কোসচে, আর।, এবং মালেজ, ডাব্লু। (2012, জুন) পেশাদার বিকাশকারীরা কীভাবে সফ্টওয়্যার উপলব্ধি করতে পারে ?. সফটওয়্যার ইঞ্জিনিয়ারিং-এর 2012 আন্তর্জাতিক সম্মেলনের কার্যক্রমে (পৃষ্ঠা 255-265)। আইইইই প্রেস।


আমি যেহেতু আরও উন্নত হয়েছি, আমি খুঁজে পেয়েছি যে সাধারণ প্লাগ এন চাগ কোডে কোডটি কী করে তা বুঝতে আমার কম মন্তব্য দরকার।
পল নাথান

3
@ পল নাথান, মন্তব্যগুলি কোডটি কী করে তা কখনই বর্ণনা করতে পারে না - কোডটি এটি আরও ভাল বর্ণনা করে। মন্তব্যগুলি ব্যাখ্যা করার জন্য আছে কেন কোডটি এটি করে তা কেন করে।
এসকে-লজিক 10

2
@ এসকে-যুক্তি: যদিও আমি যুক্তিটি বুঝতে পারি তবে আমি বিশ্বাস করি এটি খুব বিস্তৃত। কোনও ফাংশনের মন্তব্য (বা কোড অনুচ্ছেদে / ব্লক) ফাংশনটির নামের চেয়ে কী আরও বেশি (এবং দ্রুত) তা স্পষ্ট করে দিতে পারে। এটি বিশেষত জনসাধারণের কাজের জন্য প্রয়োজন। কোড পড়ার পক্ষে যতটা সহজ, 10-লাইনার কোডের একটি দ্বি-রেখার ব্যাখ্যা পড়া এখনও দ্রুত। আপনার প্রিয় এপিআইয়ের সাথে কাজ করার কল্পনা করুন যার কোনও "কী" ডকুমেন্টেশন নেই। আপনি এর কার্যকারিতা সম্পর্কে অনেক কম নিশ্চিত হন।
স্টিভেন জিউরিস

হ্যাঁ, আমি কোনও ডকুমেন্টেশন অন্তর্ভুক্ত করি নি (উদাহরণস্বরূপ, জাভাদোক) - এটি কেবল " মন্তব্যগুলি " বলা যায় না এমনটি খুব কাঠামোগত ।
এসকে-লজিক

17

পুরানো মন্তব্যগুলি একটি কাজের গন্ধ। এটি পুরানো বা অবহেলিত ইউনিট পরীক্ষা করার মতো - এটি দেখায় যে ভাল প্রসেসগুলি যেগুলি একবার দোকানে সক্রিয় ছিল তা কাউবয় কোডিংয়ের সাথে অবনতি ঘটছে। জিনিসগুলি সঠিকভাবে করতে সময় দেওয়ার সঠিক "ইঞ্জিনিয়ারিং সংস্কৃতি" ভেঙে গেছে। প্রকল্প / সংস্থা সম্ভবত প্রযুক্তি debtণে চলেছে।

সংক্ষেপে, হ্যাঁ, আপনি ভাগ্যবান হয়েছেন। আপনার ক্যারিয়ারে এখন পর্যন্ত যদি আপনি যথেষ্ট পরিমাণে চালিত শপের একটি স্ট্রিং করে থাকেন তবে এটি এত বেশি না দেখার পক্ষে যথেষ্ট সম্ভাবনা। তবে আরও সাধারণ, কম চালিত শপগুলিতে এটি বিশৃঙ্খলার সমান্তরালভাবে চলে।


"পুরানো মন্তব্যগুলি একটি কাজের গন্ধ" " খুব ভাল লাগিয়ে! অনুরূপভাবে স্ব-দলিল কোড শুধুমাত্র আপনার কোন মন্তব্য ছাড়া সমাধান, কিন্তু একটি অলস 'হ্যাক' নয়।
স্টিভেন জিউরিস

10

মন্তব্যগুলি পরীক্ষার মতো, সেগুলি আপ টু ডেট থাকলে খুব ভাল হয় তবে কোডটি না থাকলে এটি বোঝা আরও শক্ত করে তুলতে পারে।

আপনি যদি কোনও পুরানো মন্তব্য না দেখে থাকেন তবে আপনি খুব ভাগ্যবান।

আমি বেশিরভাগ কোড বেসগুলির সাথে কাজ করেছি পুরানো মন্তব্যে পূর্ণ, এবং সাধারণত আমি মন্তব্যগুলি সম্পূর্ণ উপেক্ষা করি কারণ সেগুলি সাধারণত সাহায্যের পরিবর্তে বিভ্রান্তির কারণ হয়।


আপনি কি শিল্পে কাজ করেছেন জিজ্ঞাসা করতে পারি? আমি ভাবছি যে এটি অন্যদের তুলনায় কিছুতে বেশি সাধারণ।
কার্ল বিলেফেল্ট

আমি ইউরোপের তিনটি ভিন্ন দেশে কাজ করেছি, বেশিরভাগই একটি বড় সংস্থার পরামর্শদাতা এবং একটি ছোট্ট হিসাবে। ইদানীং একটি সাস ডেভলপমেন্ট হাউসে।
কিম.নেট


10

পুরানো মন্তব্যগুলি প্রায়শই জাভাডকের মধ্যে উপস্থিত হয়:

  • যুক্তিগুলি তালিকাভুক্ত করা যা এখন আর নেই
  • সমস্ত যুক্তি ব্যাখ্যা না করা (নিখোঁজগুলি সম্ভবত পরে যুক্ত করা হয়েছিল)
  • ব্যতিক্রম ইত্যাদির জন্য একই জিনিস

অধিকন্তু, কখনও কখনও মন্তব্যগুলি স্টেটের জিনিস যেমন "পারফরম্যান্সের জন্য এটি এখানে করুন" যখন বেশিরভাগ পারফরম্যান্স বিবেচনার ক্ষেত্রে কোডের চেয়েও দ্রুত বাসি হয়ে যায়।


3
(কোনও সমালোচনা নয় - কেবল একটি সমাধান উপস্থাপন করা) IDE সতর্কতাগুলি এটি প্রতিরোধের দিকে অনেক বেশি এগিয়ে যেতে পারে। যদি আরও কঠোর পদক্ষেপের প্রয়োজন হয় তবে জাভাদোক বিল্ড সতর্কতা / ত্রুটি নির্মাণে ব্যর্থ হন।
মাইকেল কে

1
এটি কেন ব্যাখ্যা করতে পারে যে আমি কেন খুব বেশি দেখিনি। আমি কখনও কোথাও কাজ করি নি যা জাভডোক-স্টাইলের মন্তব্য ব্যবহার করে।
কার্ল বিলেফেল্ট

4
@ মিশেল, আইডিই সতর্কতাগুলি হালকা ক্ষেত্রে সহায়ক। আমাদের উত্তরাধিকার কোডবেস 20,000 ওভার Checkstyle সতর্কবার্তা উৎপন্ন করে যে সীমা যেখানে আপনি মনযোগ বন্ধ ওভার পথ: -। (((IDEs যখন খারাপভাবে ব্যবহার করা হয়, Javadoc দুর্বিপাক অবদান রাখতে পারেন উল্লেখযোগ্যভাবে আমাদের কোডবেস মধ্যে বিষ্ঠা Javadoc অধিকাংশই স্পষ্টত স্বতঃজেনারেট করা হয়।
প্যাটার তারেক

4

আমি সময়ে সময়ে পুরানো মন্তব্য মোকাবিলা। এটি অবশ্যই কোনও শহুরে মিথ নয়। লোকেরা এটি সবচেয়ে খারাপ অভ্যাসের তালিকায় উল্লেখ করে না কারণ এটি আপনাকে প্রায়শই হিট করে তবে কারণ যখন এটি ঘটে তখন সাধারণত আপনার জন্য অনেক সময় এবং প্রচেষ্টা ব্যয় হয়।

আমাদের কোডবেসে সর্বাধিক পুরানো মন্তব্যগুলি তার কলটির নিকটে এবং পদ্ধতি ঘোষণার কাছাকাছি না হয়ে পদ্ধতি আচরণের বর্ণনা দেওয়ার (বিরোধী) প্যাটার্ন ব্যবহারের কারণে ঘটে। এটি ঘটে যখন কেউ কোনও পদ্ধতিতে দীর্ঘ টুকরো কোডটি বের করেন যা এই মুহুর্তে কেবল একবার কল করা হয় এবং তারপরে পদ্ধতি কলটিতে মন্তব্য করে। সুতরাং আপনি এই জাতীয় কিছু দিয়ে শেষ:

featureList = GetFeatures();

// Sorting features and deleting empty ones from the list...
ProcessFeatures(featureList);

এবং পদ্ধতিটি কোনও মন্তব্য ছাড়াই নীচে কোথাও ঘোষণা করা হয়েছে। বছরগুলিতে লোকেরা এই পদ্ধতিগুলির সাথে বিশৃঙ্খলা পরিবর্তনের সাথে সাথে বাগগুলি স্থির করে নিয়ে যায় এবং অবশেষে আপনি এমন একটি পদ্ধতির সাথে শেষ করেন যা তালিকায় বাছাই করে না এবং খালি বৈশিষ্ট্যটি খুঁজে পেলে ব্যতিক্রম ছুঁড়ে ফেলে। সুতরাং উপরের মন্তব্যটি একটি পুরানো মন্তব্য যা শেষ পর্যন্ত আপনার ডিবাগারে কিছুটা সময় ব্যয় করবে। এগুলি কিছু কোডবেসে ঘটে।


3

নিজেকে এই জিজ্ঞাসা করুন। আপনি কি কখনও কোডের একটি লাইন পরিবর্তন করেছেন এবং যুক্ত মন্তব্যগুলি পরিবর্তন করেননি বা কোনও নতুন যুক্ত করেছেন?

আমি প্রচুর লিগ্যাসি কোড নিয়ে কাজ করেছি এবং মন্তব্যগুলি কখনও কখনও প্রাসঙ্গিকের কাছাকাছিও হয় না।


2

বেশিরভাগ ক্ষেত্রেই, আমার অভিজ্ঞতা আপনার সাথে মেলে তবে আমি এমন একটি ক্ষেত্রে জুড়েছি যেখানে কোডবেস জুড়ে এটি সত্য ছিল। এটি এমন একটি অ্যাপ্লিকেশন যা বহু বছর আগে একটি পরামর্শের শপ দ্বারা লিখিত ছিল যা ক্লায়েন্টের সাথে আর "ভাল শর্তে" ছিল না।

সংস্থাটি কোডটিতে মন্তব্য করে একটি ব্যতিক্রমী কাজ করেছে, তবে প্রোগ্রামাররা যে এটি বজায় রেখেছিল মূল হ্যান্ডঅফ থেকেই "একেবারে পরিবর্তিত হওয়া দরকার কেবল পরিবর্তিত হওয়া" মানসিকতার অংশ ছিল যা নিজের মধ্যে খারাপ নয়। দুর্ভাগ্যক্রমে, তারা মন্তব্যগুলির প্রতিও একই মনোভাব বজায় রেখেছিল, ফলে সময়ের সাথে সাথে মন্তব্য এবং কোডের মধ্যে বেশ বড় সংযোগ স্থাপন করেছিল।


2

আমি খুব বেশি বর্ণনামূলক মন্তব্য পুরানো পুরানো দেখতে পাচ্ছি না, তবে কয়েক বছর ধরে সেখানে প্রচুর টোডো মন্তব্য আমি দেখতে পাচ্ছি। আমি চাই তারা টাইম ক্যাপসুলের মতো হত এবং এরকম কিছু বলেছিল:

//TODO: In 15 years AND NO SOONER... actually implement this method.

1
এই ক্ষেত্রে সমস্যাটি সম্ভবত টোডোর অপব্যবহার। আমি বিশ্বাস করি যে কোডগুলি আসলে কার্যকরী হলে কেবলমাত্র টোডগুলি ব্যবহার করা উচিত তবে পরে উন্নতি করা যেতে পারে, সুতরাং এ TODO: implementজাতীয় মন্তব্য উপস্থিত থাকা উচিত নয় এবং আসলেই কেউ ফিরে আসেনি এ বিষয়টি তেমন গুরুত্ব দেয় না। দুঃখের বিষয়, খুব বেশি লোক এই নিয়মটি মেনে চলে না এবং আমি সম্পূর্ণরূপে সম্মত হয়েছি যে আপনি কোনও সময়ে কোনও প্রোডাকশন কোডে পোস্ট করার মতো একটি মন্তব্য দেখতে চাই। এটা আমার দিন করতে চাই।
pwny

1
সি # তে আমি এই উদ্দেশ্যে নোটিপ্লিমিটেডএক্সসেপশন ব্যবহার করি ।
স্টিভেন জিউরিস

2
@pwny, আমি যা যা লিখেছি তা নিশ্চিত করার জন্য, আমি যা পরীক্ষা করার আগে লিখতে চাইছি সেগুলিতে কেবলমাত্র টোডো ব্যবহার করি। এর চেয়ে দীর্ঘ মেয়াদী যে কোনও কিছুই এর পরিবর্তে বাগ ট্র্যাকারের সাথে আমার মতে।
কার্ল বিলেফেল্ড

@ কার্ল বিলেফেল্ড এটিও অনেক অর্থবোধ করে।
pwny

2

সর্বশেষ 3 টি প্রকল্পে আমি কাজ করেছিলাম প্রতিটি কোডকেজ থেকে পুরানো, বিভ্রান্তিকর, এবং সরল অপ্রয়োজনীয় মন্তব্যগুলি অপসারণের জন্য বেশ কয়েক দিন spent যেখানে সম্ভব এবং প্রয়োজনীয় আমি তাদের আরও উপযুক্ত মন্তব্য দিয়ে প্রতিস্থাপন করছি, তবে প্রায়শই এটি মন্তব্য মুছে ফেলার এবং এগিয়ে যাওয়ার প্রশ্নই আসে না।

আমি অন্য কোডগুলির কাছ থেকে গ্রহণ করেছি এমন প্রতিটি কোডবেসে একই কাজ করেছি, সাধারণত এটি অল্প সময়ের জন্য অবিশ্বাস্যর পরে এবং মূল মালিকরা দীর্ঘকাল চলে যায় এবং / অথবা অনিচ্ছুক বা সঠিক হ্যান্ডओভারটি করতে অক্ষম।


1

এটি মন্তব্য ব্যবহার হ্রাস হতে পারে। কারও কোড কতটা যোগ্যতা অর্জন করে? একটির জন্য, কাউকে আসলে তাদের পুরানো হওয়ার জন্য মন্তব্যগুলি অন্তর্ভুক্ত করতে হবে। দ্বিতীয়ত, যে কোডটিতে মন্তব্য করা হয়েছিল তা পরিবর্তন করতে হবে। নিশ্চিত নয় যে একটি উচ্চ-শতাংশের কোড যোগ্যতা অর্জন করে।

কোনও অ্যাপ্লিকেশনের বিশাল অংশটি নষ্ট করতে এবং আপনার প্রচুর সময় নষ্ট করতে আপনাকে কেবল একটি খারাপ মন্তব্যের উপর নির্ভর করতে হবে।


0

যে সংস্থায় প্রচুর কোড ছড়িয়ে পড়েছে, তাতে মন্তব্যগুলি সিঙ্কে রাখা শক্ত। কী হচ্ছে তা বোঝার সর্বোত্তম উপায় হ'ল সফটওয়্যারগুলি ব্যবহার করে যা আপনি যে মডিউলটিতে কাজ করছেন তার নিয়ন্ত্রণ প্রবাহ চিত্রটি আঁকেন। এটিই সফটওয়্যারটি কী করে তা অনুভব করার একমাত্র উপায়।

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.