আমি সি বা পিএইচপি কোডের ডকুমেন্টেশন তৈরি করতে ডক্সিজেন পছন্দ করি। আমার একটি আসন্ন পাইথন প্রকল্প রয়েছে এবং আমি মনে করি আমার মনে আছে যে পাইথনের কোনও /* .. */মন্তব্য নেই, এবং এর নিজস্ব স্ব-ডকুমেন্টেশন সুবিধা রয়েছে যা ডকুমেন্ট করার অজগর উপায় বলে মনে হয়।
যেহেতু আমি ডক্সিজেনের সাথে পরিচিত, আমি কীভাবে এটি আমার পাইথন ডকুমেন্টেশন তৈরি করতে ব্যবহার করতে পারি? বিশেষত এমন কিছু আছে যা সম্পর্কে আমার সচেতন হওয়া দরকার?
উত্তর:
এটি ডক্সিজেন ওয়েবসাইটে নথিভুক্ত করা হয়েছে, তবে সংক্ষেপে এখানে:
আপনি আপনার পাইথন কোডটি নথিভুক্ত করতে ডক্সিজেন ব্যবহার করতে পারেন। আপনি পাইথন ডকুমেন্টেশন স্ট্রিং সিনট্যাক্স ব্যবহার করতে পারেন:
"""@package docstring
Documentation for this module.
More details.
"""
def func():
"""Documentation for a function.
More details.
"""
pass
কোন ক্ষেত্রে মন্তব্যগুলি ডোজিজেনের মাধ্যমে আহরণ করা হবে, তবে আপনি বিশেষ ডক্সিজেনের কোনও আদেশ ব্যবহার করতে সক্ষম হবেন না ।
অথবা আপনি (ডোজিনের অধীনে সি-স্টাইলের ভাষাগুলির মতো) #সদস্যের আগে প্রথম লাইনে মন্তব্য মার্কারটিকে দ্বিগুণ করতে পারেন :
## @package pyexample
# Documentation for this module.
#
# More details.
## Documentation for a function.
#
# More details.
def func():
pass
সেক্ষেত্রে আপনি বিশেষ ডক্সিজেন কমান্ড ব্যবহার করতে পারেন। কোন বিশেষ পাইথন আউটপুট মোড, কিন্তু আপনি দৃশ্যত সেটিং দ্বারা ফলাফল উন্নত করতে পারেন OPTMIZE_OUTPUT_JAVAথেকে YES।
সত্য, আমি পার্থক্যটি সম্পর্কে একটু আশ্চর্য হয়েছি - মনে হচ্ছে একবার ডোজিজেন ## ব্লক বা "" ব্লকগুলিতে মন্তব্যগুলি সনাক্ত করতে পারলে বেশিরভাগ কাজ শেষ হয়ে যায় এবং আপনি বিশেষ কমান্ড ব্যবহার করতে সক্ষম হবেন উভয় ক্ষেত্রেই সম্ভবত তারা প্রত্যাশা করে যে "" "আরও বেশি পাইথোনিক ডকুমেন্টেশন অনুশীলনগুলি মেনে চলার জন্য লোকেরা ব্যবহার করবে এবং এটি বিশেষ ডক্সিজেন আদেশের সাথে হস্তক্ষেপ করবে?
দ্য Doxypy ইনপুট ফিল্টারকে আপনি প্রায় কাছাকাছি সব Doxygen এর বিন্যাস ট্যাগের একটি প্রমিত পাইথন docstring বিন্যাসে ব্যবহারের অনুমতি দেয়। আমি এটি একটি বড় মিশ্র সি ++ এবং পাইথন গেম অ্যাপ্লিকেশন কাঠামোর নথি হিসাবে ব্যবহার করি এবং এটি ভালভাবে কাজ করছে।
শেষ পর্যন্ত, আপনার কাছে কেবল দুটি বিকল্প রয়েছে:
আপনি ডক্সিজেন ব্যবহার করে আপনার সামগ্রী তৈরি করেন, বা আপনি স্পিঙ্কস * ব্যবহার করে আপনার সামগ্রী তৈরি করেন।
ডক্সিজেন : বেশিরভাগ পাইথন প্রকল্পগুলির জন্য এটি পছন্দের সরঞ্জাম নয়। তবে আপনাকে যদি সি বা সি ++ তে লিখিত অন্যান্য সম্পর্কিত প্রকল্পগুলির সাথে ডিল করতে হয় তবে তা বোধগম্য হতে পারে। এর জন্য আপনি ডক্সিপিপি ব্যবহার করে ডক্সিজেন এবং পাইথনের মধ্যে সংহতকরণ উন্নত করতে পারেন ।
স্ফিংক্স : পাইথন প্রকল্পটি নথির জন্য ডিফাক্টো সরঞ্জাম। আপনার কাছে এখানে তিনটি বিকল্প রয়েছে: ম্যানুয়াল, আধা-স্বয়ংক্রিয় (স্টাব জেনারেশন) এবং সম্পূর্ণ স্বয়ংক্রিয়ভাবে (ডক্সিজেনের মতো)।
autosummary_generate কনফিগারেশনের মাধ্যমে । আপনাকে অটোসমারিগুলির সাথে একটি পৃষ্ঠা সেটআপ করতে হবে এবং তারপরে ম্যানুয়ালি পৃষ্ঠাগুলি সম্পাদনা করতে হবে। আপনার কাছে বিকল্প রয়েছে, তবে এই পদ্ধতির সাথে আমার অভিজ্ঞতাটি হ'ল এর জন্য অনেক বেশি কনফিগারেশন প্রয়োজন, এবং নতুন টেম্পলেট তৈরি করার পরেও আমি পাবলিক এপিআই হিসাবে প্রকাশিত হয়েছিল এবং কী কী ঠিক তা নির্ধারণ করার জন্য বাগ এবং অসম্ভবতা খুঁজে পেয়েছি। আমার মতে এই সরঞ্জামটি স্টাব জেনারেশনের পক্ষে ভাল, যার জন্য ম্যানুয়াল সম্পাদনা প্রয়োজন হবে, এবং এর চেয়ে বেশি কিছুই নয়। ম্যানুয়ালটিতে শেষ করতে শর্টকাটের মতো।নোট করার জন্য অন্যান্য বিকল্প রয়েছে:
__all__।
স্পিনিক্স মূলত উত্স কোড থেকে স্বতঃ লিখিত দস্তাবেজগুলি বিন্যাস করার জন্য একটি সরঞ্জাম, যেমনটি আমি বুঝতে পারি।
পাইথন ডকস্ট্রিংস থেকে এপিআই ডক্স তৈরির জন্য, শীর্ষস্থানীয় সরঞ্জামগুলি হ'ল পিডোক এবং পাইডোকটর । এখানে জন্য pydoctor এর উত্পন্ন এপিআই ডক্স এর পাক এবং বাজার ।
অবশ্যই, আপনি স্টাফের উপর কাজ করার সময় যদি ডাস্টাস্ট্রিংগুলি কেবল একবার দেখতে চান তবে " পাইডোক " কমান্ড লাইন সরঞ্জাম এবং help()ইন্টারেক্টিভ ইন্টারপ্রেটারে উপলব্ধ ফাংশন রয়েছে।
অন্য একটি খুব ভাল ডকুমেন্টেশন সরঞ্জাম হ'ল স্পিংক্স । এটি আসন্ন অজগর ২.6 নথির জন্য ব্যবহৃত হবে এবং এটি জাঙ্গো এবং অন্যান্য অজগর প্রকল্প দ্বারা ব্যবহৃত হবে by
স্ফিংক্স ওয়েবসাইট থেকে: