জাভাডোক: প্যাকেজ। Html বা প্যাকেজ- ইনফো.জভা

Question

প্যাকেজ স্তরের জাভাদোক মন্তব্য তৈরি করার চেষ্টা করার সময়, পছন্দসই পদ্ধতিটি কী? আপনি কি করেন?

package-info.java

• পেশাদাররা
  • নবীনতর
• কনস
  • একটি শ্রেণীর অপব্যবহার - ক্লাসগুলি কোডের জন্য, কেবলমাত্র মন্তব্যের জন্য নয়

package.html

• পেশাদাররা
  • এইচটিএমএল এক্সটেনশনের অর্থ এর কোড নয়
  • আইডিই / পাঠ্য সম্পাদকগুলিতে সিনট্যাক্স হাইলাইট করা
• কনস
  • কোনটি?

---

আমার জন্য, আমি সর্বদা প্যাকেজ। Html ব্যবহার করেছি। তবে আমি ভাবছি এটির সঠিক পছন্দ কিনা।

Comments

package-info.java[প্যাকেজ] টীকা থাকতে পারে - এটি অগত্যা সমস্ত এপিআই ডক্স নয়।

— টম হাটিন - 5:12

আমি ক্লাসের অপব্যবহার হিসাবে প্যাকেজ-ইনফো.জভাকে যোগ্যতা অর্জন করব না। এটি একটি জাভা উত্স ফাইল (একটি "। জাভা" ফাইল এক্সটেনশান রয়েছে) তবে এটি কোনও শ্রেণিবদ্ধ ফাইল নয় কারণ এতে কোনও শ্রেণীর ঘোষণা নেই। এবং, প্রকৃতপক্ষে, এটি কোনও শ্রেণীর ঘোষণা থাকতে পারে না কারণ "প্যাকেজ-তথ্য" কোনও আইনী শ্রেণীর নাম নয় name

— স্ক্রাব্বি

প্যাকেজ html এর পরিবর্তে প্যাকেজ-ইনফো.জভা ব্যবহারের আর একটি কারণ হতে পারে যে। জাভা ডকুমেন্টেশনের একটি নির্দিষ্ট আউটপুট বিন্যাস বোঝায় না। উদাহরণস্বরূপ আপনি জাভাদোকটি ল্যাটেক্স বা পিডিএফ ফাইল হিসাবে আউটপুট করতে চাইতে পারেন। জাভাডোক সংকলক বাস্তবায়নের উপর নির্ভর করে এটি .html ক্ষেত্রে সমস্যা দেখা দিতে পারে।

— honeyp0t

আসলে @ এসক্রুবি - যদিও আপনার ঠিক হওয়া উচিত, আমি মনে করি আপনি সেখানে প্যাকেজ-প্রাইভেট ক্লাস নির্দিষ্ট করতে পারবেন। :-( আমি package-info.java

— জাভাডোক

@JonasN দেখতে stackoverflow.com/a/14708381/751579 (আমি জানি তুমি 3 বছর আগে এই সমস্যা ছিল, কিন্তু হয়তো অন্য কেউ এখন ডগা প্রয়োজন)

— davidbak

Answer 1

package-info.java: "JDK 5.0 এ এই ফাইলটি নতুন এবং প্যাকেজ html এর চেয়ে বেশি পছন্দ করা হয়েছে" "- জাভাডোক - জাভা এপিআই ডকুমেন্টেশন জেনারেটর

সংযোজন: বড় পার্থক্য হ'ল প্যাকেজ টিকা । 7.4 প্যাকেজ ঘোষণার মধ্যে যুক্তির পথে আরও কিছু আছে ।

সংযোজন: টীকাটি বৈশিষ্ট্যটি এখানে এবং এখানে উল্লেখ করা হয়েছে ।

সংযোজন: এছাড়াও কি package-info.javaজন্য দেখুন? ।

Comments

কোন বিশেষ কারণ কেন এটি পছন্দ?

— TheLQ

@ দ্য এলকিউ: আমি প্যাকেজ টীকা অনুমান করছি, সংকলকটির সাথে কাজ করার জন্য আরও তথ্য রয়েছে; আরও উপরে।

— ট্র্যাশগোড

প্যাকেজ টীকাগুলি আমার কাছে নতুন এবং এটির সুযোগের কারণে প্যাকেজ-ইনফো.জাবার পক্ষে ভাল কারণ বলে মনে হয়।

— স্ট্যাকার

উত্তরটি আরও কিছুটা সম্পাদনা করুন: "প্যাকেজ টীকা" ব্যাখ্যা করুন - একটি টীকা যা কোনও প্যাকেজের সমস্ত ক্লাসে বা অন্যথায় সামগ্রিকভাবে প্যাকেজগুলিতে প্রয়োগ করতে হয়। টেক.পিউরেডাঙ্গার ডটকম লিঙ্কটিই ছিল কেবলমাত্র আমার কেন যত্ন নেওয়া উচিত তা ব্যাখ্যা করার জন্য। এটি বলেছিল, এটি একটি ভাল, সহায়ক লিঙ্ক।

— রোবগ্রোগ

প্যাকেজ-ইনফো-জাভা ব্যবহার করে আপনি {@ লিঙ্ক} এবং অন্যান্য ডকলেট ব্যবহার করতে পারেন। আপনি যখন জাভা.এলং ক্লাসটি যুক্ত করেন, যখন জাভাদোক তৈরি হয় আপনি স্বয়ংক্রিয়ভাবে the @ লিঙ্ক av ক্লাসের অনলাইন জাভাদোকের দিকে নির্দেশ করছেন যা আপনি ব্যবহার করছেন জেডিকে মেলে; আপনি যখন রিফ্যাক্টরিং রিফ্যাক্টরিং করেন তখন আইডিয়া ভুল লিঙ্কগুলিও চিহ্নিত করতে সহায়তা করতে পারে।

— লুইজি আর ভিগিজিয়ানো