কীভাবে পরীক্ষামূলক বা অসম্পূর্ণ এপিআই ডকুমেন্ট করবেন যেমন @ বিশিষ্ট?


12

একটি ভাল শব্দটি যা অনুরূপ তবে "অবচয়" এর চেয়ে আলাদা, মানে কোনও পদ্ধতি বা এপিআই কোড বেসে রয়েছে তবে ব্যবহার করা উচিত নয় কারণ এর বাস্তবায়ন সম্পূর্ণ হয়নি বা সম্ভবত পরিবর্তিত হবে? (হ্যাঁ, আমি জানি, এই পদ্ধতিগুলি সর্বজনীন হওয়া উচিত নয়, ইয়াদ ইয়াদ ইয়াদা y আমি আমার পরিস্থিতি তৈরি করি নি, আমি কেবল এটির সেরাটি তৈরি করার চেষ্টা করছি))

লোকেরা কী পরামর্শ দেয়? পরীক্ষামূলক, অসম্পূর্ণ, অন্য কিছু?

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


একটি "অস্থির" ট্যাগটিও সহায়ক f অর্থ কিছু আলাদা হবে। "এটি ঠিকঠাক কাজ করার কথা রয়েছে তবে আমরা ভবিষ্যতে কিছু পরিবর্তন করতে পারি"।
বোরজব

উত্তর:


8

উপযুক্ত শব্দটি সম্ভবত ইনকিউবেটর , এটি গুগল এবং অ্যাপাচি ব্যবহার করে:

  • গুগল ওয়েব-টুলকিট-ইনকিউবেটর

    গুগল ওয়েব টুলকিটের জন্য উইজেট এবং গ্রন্থাগারগুলির অফিশিয়াল ইনকিউবেটর ...

  • অ্যাপাচি ইনকিউবেটর

    ... উন্মুক্ত উত্স প্রকল্পগুলির গেটওয়েটি পুরোপুরি অ্যাপাচি সফটওয়্যার ফাউন্ডেশন প্রকল্পে পরিণত হওয়ার উদ্দেশ্যে ...

আপনি যদি উপরে উল্লিখিত প্রকল্পগুলি ঘনিষ্ঠভাবে পর্যালোচনা করেন তবে আপনি লক্ষ্য করতে পারেন যে "পরীক্ষামূলক" এপিআই (যেমন জিডাব্লুটিটিতে) এর মতো "ডেডিকেটেড" প্যাকেজের নাম রয়েছে com.google.gwt.gen2। এটি স্থায়ী জনসাধারণের ব্যবহারের উদ্দেশ্যে ভবিষ্যতের "চূড়ান্ত" এপিআই দূষিত করা এড়াতে - কারণ, আপনি জানেন,

"হীরার মতো পাবলিক এপিআইগুলি চিরকালই রয়েছে right আপনার কাছে এটি ঠিকভাবে পাওয়ার একটি সুযোগ রয়েছে তাই এটিকে আপনার সেরাটি দিন ..." (জোশুয়া ব্লচ, কীভাবে একটি ভাল এপিআই ডিজাইন করবেন এবং কেন এটি গুরুত্বপূর্ণ )



10

আমি @deprecatedনিখাদ ব্যবহারিক কারণে ব্যবহার করব ।

যদিও আপনি চান @deprecatedতার সঠিক অর্থটি প্রকাশ না করলেও এর একটি উল্লেখযোগ্য সুবিধা রয়েছে: জাভা সংকলক এর জন্য অন্তর্নির্মিত সমর্থন করেছে। -deprecationপতাকার সাথে সংকলন আপনাকে এমন সমস্ত জায়গা সন্ধান করতে দেয় যেখানে আপনি একটি অবহিত পদ্ধতিতে ওভাররাইড করেন, আপনার ব্যবহারকারীদের খুব দ্রুত সন্দেহজনক কোড খুঁজে পেতে সহায়তা করে। @deprecatedআপনার ডকুমেন্টেশন পড়তে আগ্রহী যে কেউ আসলে কী ঘটছে তা বোঝাতে আপনি জাভাদোক ট্যাগ ব্যবহার করতে পারেন । এটিই আপনি ব্যবহারকারীকে বলতে পারেন যে এপিআই পরীক্ষামূলক, তাদের নিজস্ব ঝুঁকিতে ব্যবহার করা উচিত।


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

2
আইডিই এবং ডক্সটি পদ্ধতিটি হাইলাইট করার জন্য এবং তারপরে একটি সংক্ষিপ্ত ব্যাখ্যা পাওয়ার জন্য আমি "* @ সম্মতিযুক্ত এটি একটি পরীক্ষামূলক এপিআই এবং সম্ভবত পরিবর্তিত হতে পারে" এমন কিছুর দিকে ঝুঁকছিলাম।
মাইকেল লেভি

কেবলমাত্র স্মরণে রাখা যে অবনমিত হয়েছে প্রচুর সতর্কতা তৈরি করবে। এটি সম্ভবত এটির মতো খারাপ হতে পারে না। পরীক্ষামূলক বৈশিষ্ট্য সম্পর্কে সতর্ক করা ঠিক হতে পারে।
বোরজব

3

পরীক্ষামূলক বা অসম্পূর্ণ বৈশিষ্ট্যগুলির সার্বজনীন এপিআইতে কিছুই করার নেই বলে আমি অন্য এপিআইগুলিতে এর আগে কখনও দেখিনি।

যেহেতু আপনার কোনও পছন্দ নেই, কেবলমাত্র একটি স্পষ্টভাবে দৃশ্যমান সতর্কতা রাখুন যে এপিআইর অংশটি পরিবর্তন সাপেক্ষে।


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