কোনও প্রোগ্রামের মন্তব্যে প্রশ্নোত্তর সাইটগুলিতে কোনও লিঙ্ক স্থাপন করা কি ঠিক আছে?


16

বেশ কয়েকটি কোডবেজে আপনি মন্তব্যগুলি দেখতে পাবেন যেমন:

 // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade)

সুতরাং আমি কয়েকটি প্রশ্ন পেয়েছি তবে এগুলি সব সম্পর্কিত।

কোনও প্রোগ্রামের মন্তব্যে এসও প্রশ্নগুলির লিঙ্ক স্থাপন করা কি ঠিক:

 // We're now mapping from the "sorted-on column" to original indices.
 //
 // There's apparently no easy way to do this in Java, so we're
 // re-inventing a wheel.
 //
 // (see why here, in SO question: http://stackoverflow.com/questions/951848)

তুমি কি এটা কর?

এবং তা করার ক্ষেত্রে ত্রুটিগুলি কী কী? (ভয়াবহ অপূর্ণতার জন্য আমার প্রথম মন্তব্য দেখুন)


9
নিজেকে মন্তব্য: এক খুব যখন যে করছেন অপূর্ণতা বিষয়ে যে সত্য যে তাই একটি উইকি আছে ঠিক কারণে শূন্য নিশ্চয়তা উত্তর (গুলি) আপনার উপর নির্ভর এখনও সঠিক হতে হবে (বা এমনকি এখনও সেখানে হতে)। মুরগি, কিছু ক্ষেত্রে প্রশ্ন নিজেই বন্ধ হয়ে যেতে পারে বা এর আসল অর্থ থেকে পরিবর্তন করা যেতে পারে। মধ্যে বিশাল পার্থক্য "বাগ 1434594 দেখুন" সূর্যের বাগ প্যারেড উপর আপনি করছি নিশ্চিত যে সূর্যের বাগ লিঙ্ক থেকে টেক্সট হইবে না ( "নয় shall" হিসেবে RFC2119 দ্বারা সংজ্ঞায়িত) পরিবর্তন। এটি বিশাল:
ত্রিস্তান সেন্ট

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

5
@ রবার্ট এস .: না, এটি কোনও মেটা নয়। এটি এসও সম্পর্কে নয়: আমি এসওকে এটির মতোই গ্রহণ করছি। এটি বিশেষত কোনও মন্তব্য থেকে কোনও এসও-এর মতো সংস্থান নিয়ে কীভাবে মোকাবেলা করা যায় সে সম্পর্কে।
ত্রিস্তান সেন্ট

1
আপনি কি আপনার দলের জন্য লিখেছেন কোড সম্পর্কে কথা বলছেন? তাদেরকে জিজ্ঞেস করো.

1
আপনি সর্বদা সম্পূর্ণ ওয়েব পৃষ্ঠাটিকে একটি সম্পূর্ণ ওয়েব পৃষ্ঠা হিসাবে সংরক্ষণ করতে পারেন, এটিকে জিপ করুন এবং এটি আপনার ডকুমেন্টারি ফোল্ডারে রেখে দিতে পারেন।

উত্তর:


7

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

আমি দেখতে পাচ্ছি না কেন এসএসএস ব্যবহার করা খারাপ জিনিস হতে পারে, যদি না তারা পুরানো প্রশ্নগুলি সংরক্ষণাগারভুক্ত করে এবং শুদ্ধ করে দেয় (যা আমি মনে করি না যে তারা করে, তবে আমি নিশ্চিত নই) - তবে তারা তা করলেও তা কোনওভাবেই না অন্য কোনও সাইটের চেয়ে খারাপ

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


5

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


এটি আকর্ষণীয়: সুতরাং আপনি আসলে পরামর্শ দিচ্ছেন যে কোনও এসও উত্তরের ক্ষেত্রে আমি এইচটিএমএল আনতে পারি এবং এটি আমার ডিভিসিএসে সংরক্ষণ করতে পারি (মার্চুয়ালিয়াল তবে এটি নয়)?
ত্রিস্তান সেন্ট

ঠিক আছে, সাধারণত আপনার পুরো জিনিসটির প্রয়োজন হয় না, কেবল প্রাসঙ্গিক বিটগুলি সঠিক? এবং আপনি উত্স রেফারেন্স করতে পারেন।

5

মূলত আপনার কোড যেমন কোন মন্তব্য নয় কারণ এটি ভাল, কাঠামোবদ্ধ এর ইত্যাদি প্রয়োজন তবে হ্যাঁ, যখন আপনার অবস্থা আদর্শ চেয়ে কম হয়, এটা গ্রহণযোগ্য এর ভালো মন্তব্য করা। এবং স্ট্যাকওভারফ্লো ডট কমের লিঙ্কগুলি অন্যের চেয়ে ভাল (এবং প্রায়শই ভাল!)।

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

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

সম্পাদনা : আমি মনে করি আমার উপরের উত্তরটি এমন ধারণা দেয় যে এটির মতো মন্তব্যগুলির প্রয়োজনীয়তা এড়ানো যায়। অবশ্যই কখনও কখনও এটি এড়ানো যায় না ; এটি কোনও লাইব্রেরিতে বাগ বা এআইপি ডিজাইনের একটি বাগ যা আপনার উপর কোনও নিয়ন্ত্রণ রাখে না। লিঙ্কগুলি সহ এই জাতীয় মন্তব্যগুলি পরবর্তী বিকাশকারীদের সাথে আসতে খুব সহায়ক।


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

2

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

যেমন কেউ উল্লেখ করেছেন, এসও একটি উইকির স্টাইল, সুতরাং এটি সম্ভবত পরিবর্তন হতে পারে তবে সাধারণত ধারণাটি একই হওয়া উচিত।

আপনি যখন অন্যদের ধারণাগুলি ব্যবহার করেন তখন আপনার ক্রেডিট দেওয়া উচিত।


1

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

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

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