কিভাবে সম্পত্তি জাভাদোক লিখতে?

Question 1

কেবলমাত্র বৈশিষ্ট্য এবং গেটার এবং সেটটার (ডিটিও-স্টাইল) সম্বলিত "সাধারণ" পোজো শ্রেণীর বৈশিষ্ট্য / সদস্যদের জন্য জাভাদোক লেখার সময় আমি প্রায়শই একটি দ্বিধায় পড়ে যাই ....

1) সম্পত্তি জন্য জাভাদোক লিখুন
বা ...
2) প্রাপ্তির জন্য জাভাদোক লিখুন

আমি যদি সম্পত্তিটির জন্য জাভাদোকটি লিখি তবে আমি পরে কোড সমাপ্তির মাধ্যমে POJO এ অ্যাক্সেস করলে আমার আইডিই (একলিপস) স্বাভাবিকভাবেই এটি প্রদর্শিত করতে সক্ষম হবে না। এবং এমন কোনও স্ট্যান্ডার্ড জাভাদোক ট্যাগ নেই যা আমাকে আসল সম্পত্তি জাভাদোকের সাথে গিটার-জাভাদোক লিঙ্ক করতে দেয়।

একটি উদাহরণ:

public class SomeDomainClass {

  /**
   * The name of bla bla bla
   */
  private String name;

  /**
   * @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc
   */
  public String getName() {  
    return name;  
  }

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

এখন পর্যন্ত আমি আমার অনুশীলনগুলি কেবলমাত্র প্রাপ্তিদের নথির জন্য বিবেচনা করছি, বৈশিষ্ট্যগুলি নয়। তবে এটি সেরা সমাধানের মতো বলে মনে হচ্ছে না ...

Question 2

জাভাদোকস তৈরি করার সময় আপনি ব্যক্তিগত সদস্যদের অন্তর্ভুক্ত করতে পারেন (-প্রাইভেট ব্যবহার করে) এবং তারপরে সেই ক্ষেত্রগুলির সম্পত্তিতে লিঙ্ক করতে @ লিঙ্কটি ব্যবহার করতে পারেন।

public class SomeDomainClass {
    /**
     * The name of bla bla bla
     */
    private String name;

    /**
     * {@link SomeDomainClass#name}
     */
    public String getName() {
        return name;
    }
}

বিকল্পভাবে, আপনি যদি সমস্ত ব্যক্তিগত সদস্যদের জন্য জাভাডোক তৈরি করতে না চান তবে আপনার কাছে সমস্ত প্রাইভেটদের ডকুমেন্ট করার জন্য একটি কনভেনশন থাকতে পারে এবং সেটারগুলিতে @ লিঙ্ক ব্যবহার করতে পারেন।

public class SomeDomainClass {
    private String name;

    /**
     * The name of bla bla bla
     */
    public String getName() {
        return name;
    }

    /**
     * {@link SomeDomainClass#getName}
     */
    public void setName(String name) {
        this.name = name;
    }
}

Question 3

লম্বোক এই জাতীয় কাজের জন্য খুব সুবিধাজনক একটি গ্রন্থাগার।

@Getter
@Setter
public class Example {
    /**
     * The account identifier (i.e. phone number, user name or email) to be identified for the account you're
     * requesting the name for
     */
    private String name;
}

যে আপনার প্রয়োজন হয়! @Getterটীকা প্রতিটি বেসরকারী ক্ষেত্রের জন্য একটি সংগ্রহকারী পদ্ধতি তৈরি করে এবং এটি javadoc সংযুক্ত করুন।

PS : লাইব্রেরিতে অনেকগুলি দুর্দান্ত বৈশিষ্ট্য রয়েছে যা আপনি চেকআউট করতে চাইতে পারেন

Question 4

আমি উভয়ই করি, এক্লিপসের স্বতঃপূরণ দ্বারা সহায়তা করে।

প্রথমত, আমি সম্পত্তিটি নথি করি:

/**
 * The {@link String} instance representing something.
 */
private String someString;

তারপরে, আমি এটি অনুলিপি করে অনুলিপিটির কাছে আটকান:

/**
 * The {@link String} instance representing something.
 */
public String getSomeString() {
    return someString;
}

গ্রহণের সাথে, @ পুনরায় বিবৃতিগুলির একটি স্ব-পরিপূর্ণতা রয়েছে - সুতরাং, আমি গেটস শব্দটি যুক্ত করি, "টি" ছোট করে রাখি এবং ছোট "টি" দিয়ে বাক্যটি অনুলিপি করি। তারপরে আমি @ রিটর্ন (ইক্লিপস স্বতঃপূরণ সহ) ব্যবহার করি, বাক্যটি আটকান, এবং তারপরে রিটার্নে টি-টি বড় করে রাখি। এটি তখন এর মতো দেখাচ্ছে:

/**
 * Gets the {@link String} instance representing something.
 * @return The {@link String} instance representing something.
 */
public String getSomeString() {
    return someString;
}

পরিশেষে, আমি সেটারে সেই নথিটি অনুলিপি করি:

/**
 * Gets the {@link String} instance representing something.
 * @return The {@link String} instance representing something.
 */
public void setSomeString(String someString) {
    this.someString = someString;
}

তারপরে, আমি এটিকে সংশোধন করব এবং একটিগ্রাহী স্বয়ংক্রিয়রূপে আপনি কেবল @ পরিমাপ ট্যাগটিই পাবেন না তবে প্যারামিটারের নামটিও পেতে পারেন:

/**
 * Sets the {@link String} instance representing something.
 * @param someString The {@link String} instance representing something.
 */
public void setSomeString(String someString) {
    this.someString = someString;
}

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

দ্রষ্টব্য যে বাক্যটি সর্বদা একটি টি দিয়ে শুরু হয় না - এটি কেবল প্রথম অক্ষরটি পেস্টিংয়ে ছাপিয়ে / পুনরূদ্ধার করা উচিত।

Question 5

আমি সত্যিই মনে করি এটি একটি সমস্যা এবং সরকারী জাভাদোক গাইড এ সম্পর্কে কিছুই বলেন না। গিগাবাইট প্রোপার্টি ব্যবহারের সাথে মার্জিত ফ্যাশনে এটি সমাধান করতে পারে (আমি সি # তে কোড করি না, তবে আমি সত্যিই এটি একটি দুর্দান্ত বৈশিষ্ট্য বলে মনে করি)।

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