কোড মন্তব্যে #XXX এর অর্থ কী?

Question

আমি কোডে এটি অনেক দেখেছি, এমনকি ভিএম এটিকে একটি বিশেষ কেস হিসাবে চিহ্নিত করে। #TODOএবং #FIXMEঅন্য দুটি ফিক্স চিহ্নিতকারীগুলি কি ভিএম হাইলাইট তবে এর #XXXঅর্থ কী?

Comments

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

— নিক

Answer 1

XXXএকটি মন্তব্য সাধারণত একটি মাথা আপ হয়। এটা হতে পারে:

• এমন কিছু যা সম্পূর্ণরূপে সঠিকভাবে প্রয়োগ করা হয়নি।
• এমন কিছু যা পরে ঠিক করা উচিত।
• একটি সম্ভাব্য সমস্যা স্পট হাইলাইট করা।
• একটি বিষয় যা সম্পর্কে আপনি নিশ্চিত নন।

আমি প্রায়ই মত আরো একটি বর্ণনামূলক ট্যাগ পছন্দের থাকেন FIXMEবা TODOবা HACK।XXXউপরেরগুলির জন্য প্রায়শই একটি ক্যাচ হিসাবে ব্যবহৃত হয়।

ফ্রিবিএসডি কোড ক্রস রেফারেন্সে 'এক্সএক্সএক্স' অনুসন্ধান করা অনেকগুলি ব্যবহারের একটি ভাল উদাহরণ। হাজার হাজার ...

Comments

মজার বিষয় হ'ল আমি নিজে এটি ব্যবহার করি। XXX বা # এক্সএক্সএক্স মূলত সংকলকটি ট্রিপ করে এবং আমাকে কোনও কিছুতে ফিরে যেতে স্মরণ করিয়ে দেয়। সাধারণত পয়েন্টার রেফারেন্স বা একটি পূর্বে অজানা মান বা পরিবর্তনশীল নাম।

— ববি

এটি আমার আসল অনুমানকে নিশ্চিত করেছে, অন্যান্য প্রোগ্রামারদের সেই মন্তব্যটিকে দেখার মতো হিসাবে হাইলাইট করার জন্য এটি কেবল একটি ট্যাগের সমস্ত ট্যাগ।

— জোর্হে ভার্গাস

ট্রল করার চেষ্টা করছেন না, তবে "হ্যাক" বর্ণনামূলক নয়। আসলে এটি খুব অস্পষ্ট। আমার কাছে এটি কমপক্ষে 3 টি জিনিস বোঝাতে পারে।

— Рахматуллин

@ Source উত্স কোডে আমি সর্বদা এটি "কুৎসিত হ্যাক কাজ, তবে এটি যথেষ্ট ভালভাবে কাজ করছে" বোধে পড়তে চাই - এমন কিছু যা আপনি পরে পরিষ্কার করতে চান তবে তা জরুরি নয়। আমি এটি ব্যবহার করি নি (আমি সাধারণত ব্যবহার করি TODOবা XXXপরিবর্তে) তবে আমি এটির ব্যাখ্যা করব।

— আইরিডইন

Answer 2

• NOTE: কোডটি কীভাবে কাজ করে তার বিবরণ (যখন এটি স্বতঃসিদ্ধ হয় না)।
• XXX: সম্ভাব্য সমস্যা সম্পর্কে সতর্কতা, হিসাবে ব্যবহার করা যেতে পারে NOTE:XXX:।
• HACK: কোনও সমস্যা / ত্রুটি রোধ করার জন্য খুব ভাল লিখিত বা ত্রুটিযুক্ত কোড নয়। হিসাবে ব্যবহার করা উচিত HACK:FIXME:।
• FIXME: এটি কাজ করে, সাজানো, তবে এটি আরও ভাল করা যায়। (সাধারণত হরফে লিখিত কোড যাতে পুনরায় লেখার প্রয়োজন হয়)।
• BUG: এখানে একটা সমস্যা আছে.
• TODO: কোনও সমস্যা নেই, তবে অতিরিক্ত কোড লেখা দরকার, সাধারণত যখন আপনি কোনও কিছু এড়িয়ে যাচ্ছেন।

অন্তত এইভাবেই এই ট্যাগগুলি সম্পর্কে আমাকে শেখানো হয়েছিল। মূলত প্রথম দুটি ( NOTEএবং XXX) তথ্যের জন্য ব্যবহৃত হয় এবং কোনও পদক্ষেপের প্রয়োজন হয় না। যদিও গত তিন ( FIXME, BUGএবং TODO) কর্ম প্রয়োজন নেই। HACKএর মাঝে কোথাও রয়েছে (এবং আমি মনে করি না কেন?)।

Comments

ভাল তালিকা। আমিও পছন্দ করি LAZY(FIXME বা HACK হিসাবে সমালোচনা নয়) এবং OCD(পরিচিত ওভারেঞ্জাইনারিং)

— ব্রেন্ডন বাইার্ড

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

— ডন হ্যাচ

Answer 3

২০০৫ সালের জুনের পাইথন এনহান্সমেন্ট প্রস্তাবের কিছু নোট যা প্রত্যাখ্যান করা হয়েছিল ।

মধ্যে নির্বাচন FIXMEএবং XXXকঠিন।
XXXআরও সাধারণ বলে মনে হচ্ছে তবে বর্ণনামূলক কম।
তদ্ব্যতীত, XXXকোডের একটি অংশে একটি দরকারী স্থানধারক
যা অজানা।

এইভাবে FIXMEপছন্দসই বানান।
সূর্য বলেছে XXXএবং FIXMEকিছুটা আলাদা, XXXউচ্চতর তীব্রতা দেয়।
যাইহোক, এই বিষয় নিয়ে কয়েক দশকের বিশৃঙ্খলা, এবং প্রচুর লক্ষ লক্ষ
বিকাশকারী যারা সূর্যের দ্বারা প্রভাবিত হবে না, তাদের যথার্থ প্রতিশব্দ বলা সঠিকভাবে সহজ।

---

পিইপি শুরু হয়,

এই পিইপি প্রত্যাখ্যান করা হয়েছে। সম্প্রদায় আগ্রহী হতে পারে,
তবে মানক গ্রন্থাগারটিকে এই মানের সাথে সঙ্গতিপূর্ণ করার কোনও ইচ্ছা নেই।

...

কোডেট্যাগ কি?

প্রোগ্রামাররা ব্যাপকভাবে অ্যাড-হক কোড মন্তব্য মার্কআপ কনভেনশনগুলি কোডের এমন বিভাগগুলির অনুস্মারক হিসাবে পরিবেশন করতে ব্যবহার করে যার নিকটতর পরিদর্শন বা পর্যালোচনা প্রয়োজন need মার্কআপ উদাহরণ অন্তর্ভুক্ত FIXME, TODO, XXX, BUG, কিন্তু উপস্থিত সফ্টওয়্যার ব্যাপক ব্যবহারে আরো অনেক। এই জাতীয় চিহ্নিতকরণকে এরপরে কোডেট্যাগ হিসাবে উল্লেখ করা হবে । এই কোডেটাগুলি অ্যাপ্লিকেশন কোড, ইউনিট পরীক্ষা, স্ক্রিপ্টস, সাধারণ ডকুমেন্টেশন বা যেখানে উপযুক্ত উপযুক্ততে প্রদর্শিত হতে পারে।

---

পিইপি একটি আকর্ষণীয় পড়া।

Answer 4

কটাক্ষপাত আছে PEP350 । এটা সব ব্যাখ্যা করে TODO, XXXইত্যাদি আমি এটা দৈনন্দিন ব্যবহার যখন আমি কোড ট্যাগ উপায়ে ঠিক কি এক মনে করতে পারেন না।

Comments

আপনি কি জানেন যে PEP350 এই লেবেলের উত্স কিনা? এই লেবেলগুলি কীভাবে ব্যবহার করবেন তা বর্ণনা করে আপনি কোনও প্রাচীন ডকুমেন্ট (ইউনিক্স যুগ থেকে) জানেন?

— 26 Рахматуллин

Answer 5

আমি ব্যবহার করি XXXকারণ এটি টাইপ করা সহজTODO ।

XXX আপনি যখন তাড়াহুড়ো করবেন তখন তার জন্য এবং এটি নিজেই ফিরে পাবেন।

TODO আপনার যখন এটি অন্য কারও হাতে তুলে দিতে হবে তখন for

Comments

XXX এর অর্থ "আমি তাড়াতাড়ি আছি এবং আমি নিজেই এটিতে ফিরে আসব" টডোর অর্থ "এটি ভবিষ্যতের ব্যাকলগ অনুরোধের একটি আনুষ্ঠানিক অংশ যা অন্য কারও কাছে নিযুক্ত করা হবে।" সেগুলি আক্ষরিক অর্থ।

— এস.লোট

আরআরএফসি এর "আক্ষরিক অর্থ" কোনটি? নাকি এর জন্য অন্য কোনও প্রশংসাপত্র রয়েছে?

— রেন্ডাল

@ রান্ডাল: "প্রশংসাপত্র"? দুঃখিত, অনেক কোড পড়ার পরে এটি আমার বোধগম্য।

— এস। লট

Answer 6

সম্ভবত এটি এমন কেসগুলির জন্য যে আপনি কীভাবে পরিচালনা করতে জানেন না।
এটি দেখুন: টোডো / ফিক্সএমএ / এক্সএক্সএক্স / হ্যাক বিবৃতিগুলির তালিকা দেখুন

Alt টেক্সট http://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenhot.PNG

Answer 7

(পুরানো) জাভা কোড কনভেনশন থেকে :

জালিয়াতিপূর্ণ হলেও কার্যকর এমন কিছুতে পতাকাঙ্কিত করতে একটি মন্তব্যে XXX ব্যবহার করুন। বোগাস এবং ভাঙ্গা এমন কিছু পতাকাঙ্কিত করতে FIXME ব্যবহার করুন।

Answer 8

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

Answer 9

আমি বিশ্বাস করি যে FIXMEএটি বিকাশকারীর HACKপক্ষে এবং রক্ষণাবেক্ষণকারীর XXXপক্ষে, ব্যবহারকারীর পক্ষে।

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

তবে এর জন্য FIXME, আপনি কোডটি এটি কার্যকর করে ঠিক করার জন্য উপযুক্ত বোধ করবেন। এবং জন্যHACK , আপনি এটি ব্যবহার না করা সত্ত্বেও আপনার আর কোনও পছন্দ হতে পারে না।

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

Answer 10

আমি // এক্সএক্সএক্সএক্স ব্যবহার করি যাতে লাইনের নম্বরগুলি মনে রাখার দরকার নেই। পরিবর্তে আমি যখন কোডের এই টুকরোটিতে ফিরে যেতে চাই তখন আমি কেবলমাত্র XXX এর সন্ধান করি।