কোনও ফাংশন থেকে ডক্টরসিং করা


183

আমি নিম্নলিখিত ফাংশন আছে:

def my_func():
    """My docstring is both funny and informative"""
    pass

আমি কীভাবে ডক্টরসিং এ অ্যাক্সেস পাব?


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

উত্তর:


243

ইন্টারেক্টিভভাবে, আপনি এটি দিয়ে প্রদর্শন করতে পারেন

help(my_func)

অথবা কোড থেকে আপনি এটিকে পুনরুদ্ধার করতে পারেন

my_func.__doc__

1
বিটিডাব্লু: এই কৌশলটি বিল্টিন ফাংশনগুলির পাশাপাশি মডিউল এবং ক্লাসগুলির (পরীক্ষার সহায়তা () খুব সহজে বস্তুগুলির সাথেও কাজ করে -) কাজ করে। এটি আপনার অজগর শেলটিকে একটি ইন্টারেক্টিভ সহায়তা শেল করে তোলে!
ড্যারেন টমাস

3
আইপথন প্রম্পটে, আপনি আমার_ফান্ক করতে পারবেন ?? এবং এটি পাশাপাশি ডক্ট্রিংও প্রদর্শন করবে।
রোনাক

1
সহায়তা (ফানক) ফান্কের সময় একটি পঠনযোগ্য আউটপুট দেয় __ ডক __ একটি ইনলাইন আউটপুট দেয়। উত্তর করার জন্য ধন্যবাদ.
imsrgadich

77

আপনি ব্যবহার করতে পারেন inspect.getdoc। এটি __doc__স্পেসগুলিতে ট্যাবগুলিকে সাধারণকরণ করে এবং সাধারণ নেতৃস্থানীয় স্থানগুলি সরাতে ডক বডিটি বামে স্থানান্তরিত করে পরিষ্কার করে ।


7

আইপথন বা জুপিটার নোটবুকে, আপনি উল্লিখিত সমস্ত উপায় ব্যবহার করতে পারেন, তবে আমি সাথে যাই

my_func?

অথবা

?my_func

উভয় পদ্ধতির স্বাক্ষর এবং ডকস্ট্রিংয়ের দ্রুত সংক্ষিপ্তসার জন্য।

আমি ব্যবহার এড়ানো

my_func??

(যেমন @ রোহান মন্তব্য করেছেন) ডক্ট্রিংয়ের জন্য এবং এটি কেবল উত্স কোডটি পরীক্ষা করতে ব্যবহার করুন

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.