কোড মন্তব্যে পিরিয়ডস / ফুল স্টপস সম্পর্কে আপনার মতামত কী? [বন্ধ]

Question

আমি এসও ট্যাভারে এটি জিজ্ঞাসা করেছি, তাই আমি এখানে প্রশ্ন পোস্ট করছি। আমি এটি একটি আকর্ষণীয় প্রশ্ন ভেবেছিলাম। (অবশ্যই এটি এসও এর অন্তর্ভুক্ত নয়, তবে আমি মনে করি এটি এখানে ঠিক আছে)

আপনি কি আপনার কোড মন্তব্যে পিরিয়ডগুলি (বা, যেমন ওপি লিখেছেন, "পুরো স্টপস") যুক্ত করবেন?

এটিকে প্রাসঙ্গিক রাখতে কেন ?

Comments

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

— টিম

Answer 1

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

// This function returns an average of two integers. Note that it may
// return an irrelevant result if the sum of a and b exceeds the int
// boundaries.

int avg(int a, int b)   // make it static maybe?
{
    // A better algorithm is needed that never overflows
    return (a + b) / 2; 
}

Comments

+1 টি। এটি দেখতে আমার মন্তব্য শৈলীর মতো দেখে মনে হচ্ছে এটি আমাকে একটি মিথ্যা দেজা ভি দিয়েছে। :)

— ববি টেবিলগুলি

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

— রক

<জোক >>

— পূর্ব

@ ইয়ার: গড় গড়ে সর্বদা a এবং b এর মধ্যে থাকে, যা সংজ্ঞা অনুসারে সর্বদা সীমানায় থাকে, তাই না? ;)

— মোজুবা

আমার সমস্ত স্ট্রিংগুলি বাতিল হয়ে গেছে, সুতরাং একটি যথাযথ মন্তব্য সর্বদা '\ 0' দিয়ে শেষ করা উচিত আপনি কি চান না যে পরের লোকটি আপনার কোডটির দিকে তাকিয়ে তার মনের শেষটি পড়তে পারে?

— কোডেক্সআর্কানিয়াম

Answer 2

হ্যাঁ, কারণ মন্তব্যগুলি ইংরেজিতে, এবং যথাযথ ইংরেজিতে বিরামচিহ্ন ব্যবহার করা হয়।

Comments

কিভাবে টেক্সট বার্তা সম্পর্কে?

— মোশে

@ মোশি, পাঠ্য বার্তাগুলি খুব কমই সঠিক ইংরেজি।

— ডোমিনিক ম্যাকডোনেল

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

— সিজেএমউকে

@ সিজেএমউকে, লোল, হ্যাঁ এবং আমিও তাই করি। আমি ভেবেছিলাম যে মোশি এর কারণ হিসাবে আমরা যতিচিহ্ন ব্যবহার করব না, কারণ আমি নিয়মিত "সেই WD b gr8 cu বাইকে" এর মত বার্তা পাই যা আমাকে দেয়াল চালিত করে

— ডমিনিক ম্যাকডোনেল

আমি আপনাকে

— জানাতে পারি না যে

Answer 3

আপনি কি আপনার কোড মন্তব্যে পিরিয়ডগুলি (বা, যেমন ওপি লিখেছেন, "পুরো স্টপস") যুক্ত করবেন?

এটিকে প্রাসঙ্গিক রাখতে কেন?

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

উত্স কোডটি সাধারণ পাঠ্য নয় এবং তাই আমরা এর জন্য বিভিন্ন বিধি ব্যবহার করি। সরল ;-)

Comments

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

— লেনি প্রোগ্রামার্স

@ লেনি 222 - আপনি এখানে কী জিজ্ঞাসা করছেন তা নিশ্চিত নয়। ইমেলগুলি সাধারণ পাঠ্যের মতো লিখতে হবে; যেমন আপনি যেমন বলেছিলেন তেমন একটি চিঠি লিখছেন। সেগুলি আসলে কীভাবে লিখিত হয় (এবং এসএমএসগুলি, ওহ ছেলে, এসএমএসে আমাকে আরম্ভ করবেন না :) উত্স কোডটি সাধারণ পাঠ্যের মতো একই নিয়মের অধীন হয় না, কারণ এটির নিজস্ব বাক্য বিন্যাস রয়েছে।

— রক

আমার কাছে সোর্স কোড মন্তব্যগুলি মনুষ্য দ্বারা পড়া। কিছু তথ্য আলাদা স্পেসিফিকেশন ডকুমেন্টে আছে বা সোর্স কোডের মন্তব্যে এম্বেড করা আছে কেন এটির কেন পার্থক্য করা উচিত?

— লেনি প্রোগ্রামার্স

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

— রক

হ্যাঁ, আমি মনে করি আমরা না জেনে একে অপরের সাথে একমত। ;)

— লেনি প্রোগ্রামাররা

Answer 4

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

Comments

পিরিয়ডস একটি বাক্য শেষ হওয়ার জন্য। মন্তব্যগুলি সম্পূর্ণ বাক্য নয়।

— জন বি ল্যাম্বে

মন্তব্যগুলি, সাধারণভাবে, বাক্য হওয়া উচিত। যদি না হয় তবে আমার কেন জিজ্ঞাসা করা উচিত? যদি আপনার মন্তব্যগুলি এত সংক্ষিপ্ত হয় যে এগুলি বাক্য নয়, তারা সম্ভবত স্পষ্ট এবং অতএব অতিরিক্ত প্রয়োজন?

— দ্রুত_ এখন

Answer 5

আমি যদি একটি পূর্ণ বাক্য লিখি (বা আরও), তবে হ্যাঁ। যদি আমি না করি, তবে কখনও কখনও না, তবে সাধারণত এখনও হ্যাঁ।

আমি মাঝে মাঝে পাগল হয়ে যাই এবং উদ্দীপনা পয়েন্ট, প্রশ্ন চিহ্ন ইত্যাদি ব্যবহার করি;)

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

Comments

আপনি যদি প্রশ্ন চিহ্ন ব্যবহার করেন, আপনি নিজের কোডটি বুঝতে পারছেন?

— মোশে

@ মোশে: এগুলি সাধারণত টোডগুলিতে থাকে যখন আমি এখনও নিজের কোডটি পুরোপুরি বুঝতে না পারি।

— অ্যাডাম শিখুন

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

— সিজেএমউকে

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

— লেনি প্রোগ্রামার্স

Answer 6

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

আর একটি বিষয় যা প্রাসঙ্গিক হতে পারে তা হল বিস্মৃত চিহ্নগুলি, বিশেষত বহুগুণগুলি এড়ানো । উদাহরণ:

    // Though loop is labor-intensive, performance is fine with with 95K cases!!!

এবং

    // This code really sucks!

অন্যদিকে, প্রশ্ন চিহ্নগুলি মাঝে মাঝে বেশ কার্যকর হয়:

    // TODO: What does Crojpler.bway() actually do?

Answer 7

এটা নির্ভর করে. যদি আমি একটি বড়, সঠিক অনুচ্ছেদ লিখে রাখি যা কোডের ব্লক কী করে তা ব্যাখ্যা করে, তবে আমি যথাযথ লেখার অন্য কোনও অংশের মতো এটিও যথাযথভাবে বিরামচিহ্ন করে। OTOH, যখন আমি কেবল কোডের একটি লাইন মন্তব্য করি, তখন আমি করি না।

কেন? - আমি কেন সঠিক লিখন ব্যবহার করে ইমেল লিখি তার অনুরূপ, আমি এসএমএস বার্তায় শর্টহ্যান্ড বাক্য ব্যবহার করতে পারি। একটি ক্ষেত্রে আমি পাঠ্যের একটি সঠিক ব্লক লিখতে বসেছি, সুতরাং আমি কেবল স্বয়ংক্রিয়ভাবে "এটি সঠিকভাবে করব", অন্যদিকে এটি কেবল একটি সংক্ষিপ্ত নোটের পয়েন্ট পেতে।

আমার কোড থেকে বাস্তব উদাহরণ:

দ্রুত নোট মন্তব্য:

// check for vk_enter

"যথাযথ" পদ্ধতির ডকুমেন্টেশন:

// This method sets up a workspace tab with the given name. Each MDI window has a parent
// workspace specified when it's saved. The code which loads each MDI window then point it to
// the correct workspace.

Comments

.NET বিকাশকারী, তাই না? ;-)

— মোশে

@ মোশে: জাভা আসলে। এটি একটি খুব বড় এবং জটিল অ্যাপলেট থেকে কোড, মূলত ব্রাউজারে চালিত ব্যতীত ডেস্কটপ সুইং অ্যাপের মতো। :)

— ববি টেবিলগুলি

যদিও আমি এমডিআই একটি নেট শব্দ।

— মোশে

@Moshe: নাহ, এটা জেনেরিক (এর en.wikipedia.org/wiki/Multiple_document_interface )।

— ববি টেবিলগুলি

Answer 8

হ্যাঁ আমি মনে করি আপনি এইভাবে একটি ভাল কোডিং কনভেনশন তৈরি করেন এবং এটি তৃতীয় ব্যক্তির জন্য আপনার কোড পর্যালোচনা করার জন্য একটি ঝরঝরে পাঠযোগ্য কোডও তৈরি করে।

Comments

দ্বিতীয় ব্যক্তির কী হবে?

— ডেভিউলেস

Answer 9

আমি তাই চাই সবসময় সঠিকভাবে পুঁজিতে এবং স্বরাঘাত যখন তৈরি এক্সএমএল মন্তব্য যে আমি দেখা যায় আশা IntelliSense এবং আমাদের মধ্যে উত্পন্ন ডকুমেন্টেশন । এগুলি অনেক বেশি আনুষ্ঠানিক নির্মাণ এবং এগুলি হিসাবে ব্যবহার করা উচিত।

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