কীভাবে জাভাদোকসে কোডের উদাহরণগুলি আপ টু ডেট রাখতে হবে


9

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

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

এপিআইটি বিকশিত হওয়ার সাথে সাথে আমি নিজেই প্রতিটি উদাহরণ বারবার পরীক্ষা করে দেখতে পারি। এই কাজ করতে একটি ভাল উপায় আছে কি?

আমি ডকুমেন্টেশন এবং উদাহরণগুলি একটি পৃথক প্রকল্পে (উদাহরণস্বরূপ ক্যালিপার টিউটোরিয়াল ) সরানো বিবেচনা করেছি যাতে এটি নিয়মিত কোডের সাথে পুনরায় ফ্যাক্টর এবং সংকলন করা যায়। তবে এটি ডকুমেন্টেশনটিকে ক্লাস থেকে দূরে সরিয়ে দেয়।

তাই হ্যা. আমি আমার কেক রাখতে চাই এবং এটিও খেতে চাই। : ডি

 * <h2>Tokenization</h2>
 * 
 * Tokenization cuts up a string into tokens e.g.
 * <code>chilperic ii son of childeric ii</code> is tokenized into
 * <code>[chilperic, ii, son, of,
 * childeric, ii]</code>. Tokenization can also be done repeatedly by tokenizing
 * the individual tokens e.g.
 * <code>[ch,hi,il,il,lp,pe,er,ri,ic, ii, so,on, of, ch,hi,il,ld,de,er,ri,ic, ii]</code>
 * <p>
 * 
 * <pre>
 * <code>
 * {@code
 *  return new StringMetricBuilder()
 *          .with(new SimonWhite<String>())
 *          .tokenize(new Whitespace())
 *          .tokenize(new QGram(2))
 *          .build();
 * }
 * </code>
 * </pre>
 * 
 * <p>

উপরের এটি খুব বিমূর্ত যদি। এটি ডকুমেন্টেশনের একটি নমুনা। বর্তমানে আমি কার্যকর জাভা দ্বারা পরামর্শ হিসাবে স্থির কনস্ট্রাক্টর যুক্ত করছি যেমন Tokenizers.createQGram(2)কনস্ট্রাক্টর পদ্ধতির অবমূল্যায়ন করার সময়। প্রতিবার যখন আমি এই জাতীয় কিছু করি, আমাকে উপরের উদাহরণ কোডটি আপডেট করতে হবে এবং এটি এখনও কাজ করে কিনা তা পরীক্ষা করে দেখতে হবে।

উত্তর:


8

এটি আপনার প্রশ্নের উত্তর দিতে পারে না - আপনার ডকুমেন্টেশনে এই উদাহরণগুলি থাকা কতগুলি 'প্রয়োজনীয়তা' এর উপর নির্ভর করে।

সম্ভবত আপনি একটি ভিন্ন কোণ করতে পারেন: আপনার JUnit পরীক্ষায় উদাহরণ সরবরাহ করুন। (সম্ভবত কম.এক উদাহরণের মতো একটি প্যাকেজ) মন্তব্যগুলিতে কোডের সাথে সমস্যাটি হ'ল আপনার আইডিই বেশিরভাগ অংশে এটিকে এড়িয়ে চলেছে। তবে আপনার আইডিই আপনার JUnit পরীক্ষায় কোডটি বৈধ করবে। এটি করে আপনি কোডের উদাহরণগুলি 'সঠিক' তা নিশ্চিত করেছেন - পরীক্ষাগুলি সংকলন করবে না বা আপনি আপডেট না করলে কেবল ব্যর্থ হবে না।

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

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

একটি প্রসারিত লক্ষ্য হিসাবে, আপনার JUnit উদাহরণগুলি চালানোর সময় আপনি কোড কভারেজটি যুক্ত করতে পারেন। এইভাবে আপনি এক নজরে জানতে পারবেন যে আপনার কোড বেসটির কতটা উদাহরণ আপনার দ্বারা আবৃত covered


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