codestyle; জাভাডোক লাগাবার আগে বা পরে টীকা দেওয়া?


183

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

/**
 * This is a javadoc comment before the annotation 
 */
@Component
public class MyClass {

    @Autowired
    /**
     * This is a javadoc comment after the annotation
     */
    private MyOtherClass other;
}

উত্তর:


191

টীকা দেওয়ার আগে, যেহেতু টীকাটি কোডটি যা শ্রেণীর সাথে "সম্পর্কিত" " সরকারী ডকুমেন্টেশনে জাভাদোক সহ উদাহরণগুলি দেখুন ।

এখানে অন্য একটি সরকারী জাভা পৃষ্ঠায় আমি এলোমেলো উদাহরণ পেয়েছি :

/**
 * Delete multiple items from the list.
 *
 * @deprecated  Not for public use.
 *    This method is expected to be retained only as a package
 *    private method.  Replaced by
 *    {@link #remove(int)} and {@link #removeAll()}
 */
@Deprecated public synchronized void delItems(int start, int end) {
    ...
}

8
এখানে আগ্রহের বিষয়ও - পদ্ধতির অন্যান্য যোগ্যতা অর্জনকারীগুলির মতো টীকাগুলি একই লাইনে রয়েছে। আমি এর আগে কখনও এটি দেখিনি but
আর্টঅফ ওয়ারফেয়ার

8
আপনি যদি জ্যাকসনের মতো টিকা-ভারী কিছু ব্যবহার করে থাকেন তবে একই লাইনে একই টীকাগুলি স্থাপন করা খুব দ্রুতই হাতছাড়া হয়ে যেতে পারে। আমি প্রতিটি টীকাটি তার নিজস্ব লাইনে রেখেছি।
ডাব্লুডাব্লু

17

আমি ইতিমধ্যে দেওয়া উত্তরগুলির সাথে একমত।

টীকা অংশ কোড যখন javadoc অংশ ডকুমেন্টেশন (তাই নাম)।

সুতরাং আমার জন্য কোড অংশগুলি একসাথে রাখা যুক্তিসঙ্গত seams।


11

এটি সবই পঠনযোগ্যতায় নেমে আসে। আমার মতে কোডটি পদ্ধতি / ক্ষেত্রের সরাসরি উপরে টীকাগুলির সাথে আরও পঠনযোগ্য।


11

কোডিং স্ট্যান্ডার্ডকে বাদ দিয়ে, মনে হয় জাভাদোক সরঞ্জাম জাভাদোক মন্তব্যগুলিকে টীকাগুলির পরে স্থাপন করা হয় না। অন্যথায় ভাল কাজ করে।


0

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

বাগ প্রতিবেদনটি এখানে দেখুন: https://youtrack.jetbrains.com/issue/IDEA-220520

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