সরল গেটর / সেটার মন্তব্য comments

124

গেটার্স এবং সেটটারদের মন্তব্য করতে আপনি কোন সম্মেলন ব্যবহার করেন? এটি এমন কিছু যা আমি বেশ কিছু সময়ের জন্য ভাবছিলাম, উদাহরণস্বরূপ:

/**
 * (1a) what do you put here?
 * @param salary (1b) what do you put here?
 */
public void setSalary(float salary);

/*
 * (2a) what do you put here?
 * @return (2b)
 */
public float getSalary();

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

আমি কেবল কৌতূহলী যদি, সহজ গেটার / সেটারদের জন্য কেবল (ক) অংশ বা (খ) অংশটি পূরণ করা ঠিক হয়।

আপনি কি মনে করেন?

— ThaDon
সূত্র

54

অন্যদিকে, দয়া করে কোনও আর্থিক জন্য (যেমন এখানে বেতন হিসাবে) কখনও ভাসা ব্যবহার করবেন না। যেমন দেখুন stackoverflow.com/questions/965831/...

— Jonik

3

পরিবর্তে বিগডিসিমাল ব্যবহার করুন।

— জোসেপ

83

আমি সাধারণত কেবল সেটারদের জন্য পরম অংশটি পূরণ করি, এবং গেটারদের জন্য @ রিটার্ন অংশ:

/**
 * 
 * @param salary salary to set (in cents)
 */
public void setSalary(float salary);

/**
 * @return current salary (in cents, may be imaginary for weird employees)
 */
public float getSalary();

এইভাবে জাভাডোক চেকিংয়ের সরঞ্জামগুলি (যেমন এক্লিপের সতর্কতাগুলি) পরিষ্কার বেরিয়ে আসবে এবং এর কোনও সদৃশ নেই।

— sleske
সূত্র

আপনি টাইপো ঠিক করতে পারবেন? "

— সেটটারদের

1

বেতন () এর মন্তব্যে একটি টাইপও রয়েছে। এটি জাভাডকের মন্তব্য নয়।

— ফোস্তাহ

1

আমি সম্মত হই যে মন্তব্যকারীদের কাছে মন্তব্য করার পক্ষে এটি সর্বোত্তম পন্থা।

— ফোস্তাহ

30

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

— লাইল

1

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

— ম্যাট ভুকাস

174

একেবারে অর্থহীন - আপনার কোডকে এই জাতীয় জঞ্জাল না দিয়ে আপনি আরও ভাল হন:

/**
 * Sets the foo.
 * 
 * @param foo the foo to set
 */
public void setFoo(float foo);

খুব দরকারী, যদি নিশ্চিত হয়:

/**
 * Foo is the adjustment factor used in the Bar-calculation. It has a default
 * value depending on the Baz type, but can be adjusted on a per-case base.
 * 
 * @param foo must be greater than 0 and not greater than MAX_FOO.
 */
public void setFoo(float foo);

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

— মাইকেল বর্গওয়ার্ট
সূত্র

2

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

— থাইডন

7

এমনকি যদি এটি কার্যকর হয় তবে আপনি getFoo () এর জন্য কী করবেন। আপনি কি getFoo () এর জন্য একই মন্তব্যটি অনুলিপি করবেন?

— বিনোথ কুমার সিএম

3

@ সিএমভিভি: অবশ্যই "পরম" অংশটি অনুলিপি করা হবে না। উভয় অ্যাক্সেসরের সাথে তথ্য সংযুক্ত করার মানটি সরাসরি তথ্যের নকলকে ন্যায্যতা দেয় কিনা তা আমি সিদ্ধান্তহীন। সম্ভবত হ্যাঁ. আরও ভাল একটি উপায় উভয় একটি মন্তব্য সংযুক্ত করার উপায় হতে পারে; আমি বিশ্বাস করি এটি প্রজেক্ট লম্বক এ উপলব্ধ।

— মাইকেল বর্গওয়ার্ট

@ উইনোথকুমার: সম্ভবত গেটারের সম্পত্তিটি ব্যাখ্যা করা ভাল হবে (যেমন "ফু-এ-বার-গণনায় ব্যবহৃত সমন্বয় ফ্যাক্টর।") এবং সেটারে মান পরিবর্তন করার প্রভাবগুলি (বা এটি প্রয়োজনীয় কিনা বা সেই মানটি আরম্ভ করার জন্য নয় - উত্তরের উদাহরণে ফু এর আরম্ভ করার প্রয়োজন নেই যেহেতু "এটিতে বাজ টাইপের উপর নির্ভর করে ডিফল্ট মান রয়েছে")।

— ফ্রেইটাস

"বিনিয়োগকারী ব্যাঙ্কার, জৈব রসায়নবিদ বা কোয়ান্টাম পদার্থবিদরা বুঝতে পারেন এমন অস্পষ্ট নামগুলির জন্য +1"

— জ্যাকসন

36

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

আমি জানি যে উত্তরহীন মত শোনাচ্ছে তবে আমি ব্যাখ্যা করার প্রয়োজন এমন মন্তব্য করার জন্য আমার সময়টি ব্যবহার করার চেষ্টা করি।

— এরিক ভেন্ডেলিন
সূত্র

5

এই রেখাগুলি সহ অন্য একটি বৈধ উত্তর হতে পারে "

— গেটার এবং সেটটারগুলির

2

@ ট্রেজকাজ: সত্য নয়, কারণ অ্যাক্সেসর পদ্ধতিগুলি কেবলমাত্র পঠনযোগ্য বা কেবল লেখার বৈশিষ্ট্যগুলির জন্য, এবং পলিমারফিজমের (এবং তাই মোড়ানো, প্রক্সিং এবং আরও অনেক কিছু) মঞ্জুরি দেয়।

— লরেন্ট পাইরেইন

2

তারা এই জিনিসগুলির জন্য মঞ্জুরি দিতে পারে, তবে প্রায়শই একজন বিল্ডার প্যাটার্ন সেটারগুলি (কম পরিবর্তনযোগ্য) প্রতিস্থাপন করতে পারে বা দর্শনার্থী প্যাটার্নটি

— গেটারগুলি

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

— মাইকেল শ্যাপার

34

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

সম্পাদনা করুন: এছাড়াও, আপনি যদি নিজের গেটর / সেটারের সাথে অনেকগুলি পার্শ্ব প্রতিক্রিয়া জড়িত দেখতে পান তবে আপনি গিটার / সেটারকে একটি ভিন্ন পদ্ধতির নাম (যেমন: একটি স্ট্যাকের জন্য চাপুন এবং পপ করতে পারেন) পরিবর্তন করতে পারেন [ধন্যবাদ নীচে মন্তব্য]

— Gopherkhan
সূত্র

10

তর্কসাপেক্ষভাবে, আপনার আরও আরও স্পষ্ট হওয়ার জন্য পার্শ্ব প্রতিক্রিয়াযুক্ত গেটের নাম পরিবর্তন করা উচিত, কারণ সমস্ত বিকাশকারী মন্তব্যগুলি পড়বেন না।

— akf

এটি দুর্দান্ত - তবে এটির জন্য আপনার API এর ব্যবহারকারীদের জানা দরকার যে, যদি কোনও পার্শ্ব প্রতিক্রিয়া থাকে তবে সেগুলি নথিভুক্ত করা হত !

— অক্সবো_লেকস

আকফ, আমি পোস্ট করার পরে ঠিক সেটাই ভাবছিলাম :) আমার ধারণা আমি এটি আমার প্রতিক্রিয়াতে যুক্ত করব।

— গোফেরখান

1

তবে আপনি যদি "বোকা" getters এবং সেটার নথি না করেন (এটিও আমি পছন্দ করি!) - অনুপস্থিত জাভাডোকের উপর আপনি কীভাবে ग्रहणের সতর্কতা থেকে মুক্তি পাবেন? আমি তার মতো সতর্কতা সহ আমার কর্মক্ষেত্রকে বিশৃঙ্খলা করতে চাই না, তবে আমি চাই না যে এই সতর্কতাটি অন্য সমস্ত পদ্ধতির জন্য অক্ষম করা হোক ...

— জোর্ডিড

12

নিজেকে জাভাক ডকস হিসাবে (ব্রাউজার থেকে) মন্তব্যগুলি দেখার সময় লোকেরা কী দেখতে চায় তা নিজেকে জিজ্ঞাসা করুন। অনেক লোক বলে যে ডকুমেন্টেশন এটি প্রয়োজনীয় না থেকে প্রয়োজনীয়। ক্ষেত্রটি ব্যক্তিগত হলে এটি হোল্ড করবে না (যদি আপনি স্পষ্টভাবে ব্যক্তিগত ক্ষেত্রের জন্য জাভডোকস চালু না করেন)।

তোমার ক্ষেত্রে:

public void setSalary(float s)
public float getSalary()

কোন বেতন প্রকাশ করা হয় তা পরিষ্কার নয় এটি সেন্ট, ডলার, পাউন্ড, আরএমবি?

সেটার / গেটারগুলি নথিভুক্ত করার সময়, আমি কী এনকোডিং থেকে আলাদা করতে চাই। উদাহরণ:

/**
 * Returns the height.
 * @return height in meters
 */
public double getHeight()

প্রথম লাইনটি বলে যে এটি উচ্চতা ফিরে আসে। রিটার্ন প্যারামিটার নথি যা উচ্চতা মিটারে।

— স্টিভ কুও
সূত্র

1

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

— করলিপপিনগুলি

আমি জাভাডক্সের বড় সমর্থক, তবে স্ব-ডকুমেন্টিং কোডেরও বড় সমর্থক। সুতরাং সেটার জন্য কমপক্ষে, আমি এমন কিছু করব public void setSalary(float aud)(বা আরও বাস্তববাদী, public void setSalary(BigDecimal aud))। আরও ভাল, সম্পত্তিটি ধরণের হওয়া উচিত abstract class CurrencyAmount, যার পরিবর্তে বৈশিষ্ট্যগুলি রয়েছে java.util.Currency currencyএবং java.math.BigDecimal amount। আমি বেশিরভাগ বিকাশকারী যার সাথে কাজ করেছি তারা জাভাডকের সাথে মারাত্মকভাবে অলস, তবে এই জাতীয় এপিআই প্রয়োগ করা এটিকে কম সমস্যা তৈরি করে।

— মাইকেল শ্যাপার

ইউনিটটি যদি মিটার / সেকেন্ডের মতো এসআই ইউনিট হয় তবে নথির দরকার নেই, যদি এটি সি ইউনিট না হয় তবে নন স্ট্যান্ডার্ড ইউনিট যেমন উচ্চতাফিট অন্তর্ভুক্ত করার জন্য এটি অবশ্যই নথিবদ্ধ বা আরও ভাল নামকরণ করতে হবে

— আলেকজুইন

8

ক্ষেত্রের মান এবং গেটর এবং সেটটারদের থেকে রেফারেন্স মন্তব্য করার জন্য কেন তারা কেবল একটি রেফারেন্স ট্যাগ অন্তর্ভুক্ত করে না।

/**
* The adjustment factor for the bar calculation.
* @HasGetter
* @HasSetter
*/
private String foo;

public String getFoo() {
  return foo;
}

public void setFoo() {
  this foo = foo;
}

যাতে ডকুমেন্টেশনটি গ্রাহক এবং সেটারের পাশাপাশি ক্ষেত্রের ক্ষেত্রেও প্রযোজ্য (যদি ব্যক্তিগত জাভাদোকগুলি এটি চালু থাকে)।

— স্টিভ
সূত্র

আমি রাজী. এবং তখন আমি বুঝতে পারি, কেন এই সমস্ত বয়লারপ্লেট কোনওভাবে লিখবেন? প্রকল্প লম্বোক সম্পর্কে আমার উত্তর দেখুন।

— মাইকেল শ্যাপার

7

প্রজেক্ট লম্বোক ব্যবহার করে এই জাতীয় বয়লারপ্লেট এড়ানো যায় । কেবল ক্ষেত্রের ভেরিয়েবল নথি করুন, এমনকি privateলম্বোক টীকা সঠিকভাবে নথিভুক্ত গেটার এবং সেটটারগুলি তৈরি করতে দিন।

আমার জন্য, একা এই সুবিধা মূল্য খরচ ।

— মাইকেল শ্যাপার
সূত্র

4

আমি উত্তরগুলি সম্পর্কে সত্যই হতাশ হলাম মূলত বলা হয় ব্যাপক ডকুমেন্টিং সময় নষ্ট করা। কিভাবে আপনার API- এর ক্লায়েন্টদের জানাতে চাই যে, একটি পদ্ধতি বলা অনুমিত হয় setXএকটি হল মান জাভা বিন সম্পত্তি সেটার যদি না আপনি বলতে তাই পরিষ্কারভাবে ডকুমেন্টেশনে ?

ডকুমেন্টেশন ব্যতীত, কলকারীটির আপত্তিগত কনভেনশনটি অনুসরণ করার বিষয়ে তাদের আঙ্গুলগুলি পেরিয়ে ব্যতীত পদ্ধতিটির কোনও পার্শ্ব প্রতিক্রিয়া থাকলে তার কোনও ধারণা নেই।

আমি নিশ্চিত যে এখানে একমাত্র আমিই নই যে দুর্দশাগ্রস্ততা খুঁজে পাওয়ার জন্য যে পদ্ধতিটি বলা যায় setXকোনও সম্পত্তি নির্ধারণের চেয়ে পুরোপুরি আরও বেশি কিছু করে বলে called

— oxbow_lakes
সূত্র

11

ডকুমেন্টেশন ব্যতীত যে কোনও কলার ধরে নিবে যে সেটএক্স নামে একটি পদ্ধতি এক্স সেট করে It এটি অনুসরণ করে যে যদি সেটএক্স যদি অন্য কিছু গুরুত্বপূর্ণ না করে বাস্তবে এক্স সেট করে, তবে আপনার ডকুমেন্টেশন লাগবে না don't

— এমকিপিপি

দারুণ! এখন এই সংস্থা ক্রডটেক, যার এপিআইয়ের বিরুদ্ধে আমি কোড করছি, আপনার কনভেনশনটি অনুসরণ করে, বা এটি এই থ্রেডে অন্য কারও অনুসরণ করে? Hmmmm

— oxbow_lakes

5

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

— জোও মার্কাস

8

মনে হচ্ছে আপনি "ডকুমেন্টেশন" বলতে চাইছেন "এটি আপনি যা প্রত্যাশা করেন তা করে"। যা কিছুটা এক কাপ কফিতে "সাবধানতা: HOT" লেখার মতো। নিখুঁত বিশ্বে এ জাতীয় কথা বলার দরকার পড়ে না।

— কেভিন প্যাঙ্কো

1

হ্যাঁ - এমন এপিআই ব্যবহার করেছেন যেখানে পদ্ধতিগুলির মতো জিনিসগুলির যেমন setXপ্রত্যাশিত ব্যতীত পার্শ্ব-প্রতিক্রিয়া ছিল, আমি সত্যিই আত্মবিশ্বাসের সাথে বলতে পারি যে এটি নিখুঁত বিশ্ব নয়।

— অক্সবো_লাক্স

4

গিটার / সেটারে বিশেষ ক্রিয়াকলাপ না থাকলে আমি সাধারণত লিখি:

জাভাডোক (ব্যক্তিগত বিকল্প সহ) সহ:

/** Set {@see #salary}. @param {@link #salary}. */
public void setSalary(float salary);

এবং / অথবা

/** 
 * Get {@see #salary}.
 * @return {@link #salary}.
 */
public float salary();

অক্সিজেন সহ (ব্যক্তিগত নিষ্ক্রিয় বিকল্পের সাথে):

/** @param[in] #salary. */
public void setSalary(float salary);

/** @return #salary. */
public float salary();

— TermWay
সূত্র

2

এই পদ্ধতির সাথে সমস্যাটি হ'ল জাভাদোক ডিফল্টরূপে ব্যক্তিগত ডকুমেন্টেশন তৈরি করে না! {@see #salary}সেক্ষেত্রে উত্সযুক্ত নথিতে রেফারেন্স ট্যাগটি অবৈধ।

— জারেক প্রাইজিডজকি

1

অ্যাক্সেসরদের মন্তব্য করা, বিশেষত যদি তারা কোথাও কোনও ক্রিয়াকলাপ না করে তবে তা অপ্রয়োজনীয় এবং নখদর্পণীর অপচয়।

যদি আপনার কোড পড়ছেন এমন কেউ যদি বুঝতে না পারে যে person.getFirstName()কোনও ব্যক্তির প্রথম নামটি ফেরত দেয়, তবে তাকে বরখাস্ত করার জন্য আপনার নিজের সমস্ত ক্ষমতা দিয়ে চেষ্টা করা উচিত। যদি এটি কিছু ডাটাবেস যাদু করে, কয়েকটি ডাইস ফেলে, প্রথম নামটির সেক্রেটারিটিকে প্রথম নামটি কল করার জন্য কল করে, এটি একটি তুচ্ছ তাত্পর্যপূর্ণ কাজ বলে ধরে নেওয়া নিরাপদ এবং এটিকে ভালভাবে নথিভুক্ত করা নিরাপদ।

অন্যদিকে, যদি আপনার person.getFirstName()কোনও ব্যক্তির প্রথম নামটি না ফেরায় ... ভাল, আসুন আমরা সেখানে যাই না, আমরা কি করব?

— হেনরিক পল
সূত্র

6

যদি getFrstName () বাতিল করে দেয়? কোথায় তা নথিভুক্ত করা হবে?

— স্টিভ কুও

সিকিউরিটি.গেট ফাইনালম্যাটুরিটি () কীভাবে? সমস্ত সম্পত্তি নামগুলির তাত্ক্ষণিকভাবে বোধগম্য অর্থ হয় না। এর অর্থ কী তা না জানার জন্য আপনি কি বরখাস্ত হতে চান?

— মাইকেল বর্গওয়ার্ট

সুইজলিংয়ের মাধ্যমে যদি পদ্ধতিটি প্রয়োগ করা হয় তবে কী হবে? এটি স্পষ্টভাবে নথিভুক্ত না হলে আপনি কীভাবে জানবেন? ডক এটি না বলে আপনি কীভাবে এটি স্ট্যান্ডার্ড সেটার হিসাবে জেনে নেবেন?

— অক্সবো_লেকস

2

গেট / সেটটি আমার মতে গেটার্স এবং সেটটারদের জন্য সংরক্ষিত থাকতে হবে। ডাটাবেস লুকআপগুলির নাম "লুকআপপারসন" বা এর মতো করা উচিত।

— থোরবজর্ন রাভন অ্যান্ডারসন

1

ক্ষেত্রের নামটি সামগ্রীতে বর্ণনামূলকভাবে বর্ণনামূলক কিছু রাখবেন না।

সাধারণত, কোডটি স্ব-স্থায়ী হোক এবং যদি সম্ভব হয় তবে তা মন্তব্য করা এড়ানো উচিত। এর জন্য রিফ্যাক্টরিংয়ের প্রয়োজন হতে পারে।

সম্পাদনা: উপরেরটি কেবল গ্রাহক এবং সেটটারকে বোঝায়। আমি বিশ্বাস করি যে তুচ্ছ কোনও কিছুই যথাযথভাবে জাভাদোকড হওয়া উচিত।

— থরবজর্ন রাভন অ্যান্ডারসন
সূত্র

1

মন্তব্য এবং ডকুমেন্টিংয়ের মধ্যে পার্থক্য রয়েছে।

— টম হাটিন -

1

খুবই সত্য. ঠিক তাই আমি গেটার এবং সেটটারদের মন্তব্য করি না কেন। সেগুলি স্ব-বর্ণনামূলক হওয়া উচিত এবং একটি মন্তব্য যুক্ত করা ইঙ্গিত দেয় যে কোডটি স্ব-বর্ণনামূলক নয়।

— থোরবজর্ন রাভন অ্যান্ডারসন

0

(খ) অংশটি পূরণ করা ঠিক আছে, বিশেষত আপনি যদি ক্ষেত্রটি সম্পর্কে কী তা বোঝায় ক্ষেত্রের ঘোষণায় কোনও মন্তব্য করেন।

— akf
সূত্র

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

— ট্রেজকাজ

লোকেরা প্রয়োজন না হলে ক্ষেত্রের মন্তব্যগুলি পড়েন না। একবার যখন প্রয়োজন হয়, তত বেশি তথ্য তত ভাল।

— akf

0

জাভাডোক যদি কিছু না যোগ করে তবে আমি জাভাডোকটি মুছুন এবং স্বয়ংক্রিয়ভাবে তৈরি মন্তব্যগুলি ব্যবহার করুন।

— অ্যালেক্স বি
সূত্র

0

আমি সবসময় উভয়ই পূরণ করি। টাইপিংয়ে অতিরিক্ত সময় ব্যয় করা তুচ্ছ এবং সাধারণভাবে সাধারণের চেয়ে কম তথ্যই ভাল।

— পল সোনিয়ার
সূত্র

আপনি যদি "এটি একটি সম্পত্তি সেটেটর" বলে থাকেন তবে সেগুলি কেবল স্ব-ব্যাখ্যামূলক। অন্যথায় এপিআই-র একটি ক্লায়েন্টের পদ্ধতিগুলির মধ্যে আসলে কী ঘটছে সে সম্পর্কে কোনও ধারণা নেই

— অক্সবো_লাক

1

স্ব-ব্যাখ্যামূলক সম্পর্কে কে কিছু বলেছেন?

— পল সোনিয়ার