ওভারলোড পদ্ধতিতে জাভাদোক লেখার DRY উপায়


9

আমি DRY উপায়ে জাভাদোক লিখতে চাই। তবে জাভাদোক সম্পর্কে ওরাকল ডকুমেন্টটি ওভারলোড পদ্ধতিতে মন্তব্য করে আবার একই জিনিসটি লিখুন। আমি কি পুনরাবৃত্তি এড়াতে পারি না?

উত্তর:


3

{@inheritDoc}সুপারক্লাস থেকে ওভাররাইড পদ্ধতি বা ইন্টারফেস-সংজ্ঞায়িত পদ্ধতিগুলি প্রয়োগ করার সময় আমি আমার জাভাদোক মন্তব্যে এখানে এবং সেখানে নির্দেশনা ছিটিয়ে করি ।

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


2

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

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

এটি বলেছে, এর কোনও কারণ নেই, আপনি যদি চালাক হন তবে আপনি এমন কোনও প্রোগ্রাম লিখতে পারবেন না যা মার্কার বা কিছু অন্যান্য মানদণ্ডের ভিত্তিতে আপনার কোডগুলিতে মন্তব্যগুলিকে আটকে দেবে। এটি তার মূল্য চেয়ে বেশি ঝামেলা হতে পারে। অথবা না.


4
না, নিজেকে পুনরাবৃত্তি করবেন না; সবকিছু ঠিকঠাক রেখে দেওয়ার জন্য এটি কেবলমাত্র ওভারহেড head অতিরিক্ত লোড বাস্তবায়ন সম্পর্কে যদি নতুন তথ্য থাকে তবে কেবল এটি লিখুন। আমি মনে করি যে কোনও ধরণের ব্যবহারকারীরা এর সুপারটাইপের জাভাডোকগুলি দেখেন এবং এ্যাক্লিপসের মতো সরঞ্জামগুলি তাদের পক্ষে এটি করা খুব সহজ করে তোলে তা আশা করা যুক্তিসঙ্গত।
দাউদ ইবনে করিম
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.