পাইথন স্ট্যান্ডার্ড ফর্ম্যাটটি কি? [বন্ধ]

Question

পাইথনে ডকাস্ট্রিং রচনার কয়েকটি ভিন্ন শৈলী আমি দেখেছি, সেখানে কোনও কর্মকর্তা বা "সম্মতিযুক্ত" শৈলী আছে?

Comments

python.org/dev/peps/pep-0008 ডকুমেন্টেশন স্ট্রিংগুলিতে নিবেদিত একটি সম্পূর্ণ বিভাগ রয়েছে

— যান্ত্রিক_মেট

আমি মনে করি যে এই প্রশ্নের স্পষ্ট যথেষ্ট ছিল না কারণ PEP-257 এবং PEP -8 docstrings শুধুমাত্র বেস প্রতিষ্ঠার হয়, কিন্তু কিভাবে সম্পর্কে epydoc, doxygen, sphinx? কারও কাছে কোনও পরিসংখ্যান রয়েছে, তাদের মধ্যে একজন অন্যকে প্রতিস্থাপন করতে চলেছে, এরকম ক্ষেত্রে অনেকগুলি বিকল্প চোট দিতে পারে।

— সোমিন

@ সোরিন, আমি এটিও জানতে চাই যে কোন মার্কআপ, যদি থাকে তবে সবচেয়ে সাধারণ। তবে আমি মনে করি এর উত্তরটি হ'ল এগুলির কোনওটিই সত্যিই সাধারণ নয়: মানুষ এইচটিএমএল রূপান্তরিত না হয়ে সরাসরি পাইথনের উত্সটি দেখতে পছন্দ করেন। সুতরাং, এটি কেবলমাত্র ধারাবাহিক হতে তবে সবচেয়ে কার্যকর এমনভাবে যা মানুষের পাঠযোগ্যতার জন্য অনুকূলকৃত এবং কোনও স্পষ্ট মার্কআপ নেই।

— পুলি

: একটি বরং আকর্ষণীয় ভাবে PyCharm autocompletes, যা আমি মনে করি এটি চালানোর জন্য প্রয়োজন নির্দেশাবলীর একটা চমৎকার বাস্তবায়নdef foo(self, other):\n\t"""\n\t(blank line)\n\t:param other: \n\t:return:\n\t"""

— Matteo Ferla

এই উত্তরগুলির মধ্যে কোনটি ভিএস কোড ডকুমেন্টেশন পার্সারের সাথে ডিফল্টরূপে কাজ করে?

— উইলিয়াম এন্টারিকেন

Answer 1

ফর্ম্যাট

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

মনে রাখবেন যে পিইপি 287 দ্বারা পুনরায় সংস্থার প্রস্তাব দেওয়া হয়েছে

ডকাস্ট্রিংয়ের জন্য প্রধান ব্যবহৃত ফর্ম্যাটগুলি অনুসরণ করে।

- এপেক্সটেক্সট

Icallyতিহাসিকভাবে শৈলীর মতো একটি জাভাদোক প্রচলিত ছিল, তাই এটি ডকুমেন্টেশন তৈরির জন্য এপিডোকের ( ভিত্তিক Epytextফর্ম্যাট সহ) বেস হিসাবে নেওয়া হয়েছিল ।

উদাহরণ:

"""
This is a javadoc style.

@param param1: this is a first param
@param param2: this is a second param
@return: this is a description of what is returned
@raise keyError: raises an exception
"""

- বিশ্রাম

আজকাল, সম্ভবত আরও প্রচলিত ফর্ম্যাটটি হ'ল রিস্ট্রাকচার্ড টেক্সট (রিএসটি) ফর্ম্যাট যা স্পিনেক্স ডকুমেন্টেশন তৈরি করতে ব্যবহার করে । দ্রষ্টব্য: এটি জেটব্রেইন পাইচার্মে ডিফল্টরূপে ব্যবহৃত হয় (কোনও পদ্ধতি নির্ধারণের পরে ট্রিপল কোট টাইপ করুন এবং এন্টার টিপুন)। এটি Pomot মধ্যে আউটপুট ফর্ম্যাট হিসাবে ডিফল্টরূপে ব্যবহৃত হয়।

উদাহরণ:

"""
This is a reST style.

:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""

- গুগল

গুগলের নিজস্ব ফর্ম্যাট রয়েছে যা প্রায়শই ব্যবহৃত হয়। এটি স্পিনিক্স দ্বারা ব্যাখ্যা করা যেতে পারে (যেমন নেপোলিয়ন প্লাগইন ব্যবহার করে )।

উদাহরণ:

"""
This is an example of Google style.

Args:
    param1: This is the first param.
    param2: This is a second param.

Returns:
    This is a description of what is returned.

Raises:
    KeyError: Raises an exception.
"""

এমনকি আরো উদাহরণ

- নমপিডোক

দ্রষ্টব্য যে নম্পি গুগল ফর্ম্যাটের ভিত্তিতে এবং স্পিঙ্কস দ্বারা ব্যবহারযোগ্য their

"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.

Parameters
----------
first : array_like
    the 1st param name `first`
second :
    the 2nd param
third : {'value', 'other'}, optional
    the 3rd param, by default 'value'

Returns
-------
string
    a value in a string

Raises
------
KeyError
    when a key error
OtherError
    when an other error
"""

রূপান্তর / জেনারেট

পাইথন প্রজেক্টে স্বয়ংক্রিয়ভাবে ডকাস্ট্রিং তৈরি করার জন্য পাইপথারের মতো একটি সরঞ্জাম ব্যবহার করা সম্ভব যা এখনও নথিভুক্ত হয়নি, বা বিদ্যমান ডকাস্ট্রিংগুলি (একাধিক ফর্ম্যাটকে মিশ্রণ করতে পারে) একটি ফর্ম্যাট থেকে অন্য একটিতে রূপান্তর করতে।

দ্রষ্টব্য: উদাহরণগুলি Pomot ডকুমেন্টেশন থেকে নেওয়া হয়েছে

Comments

আমি যোগ করতে পারি যে জাস্টব্রেইন পাইচার্মে ডিফল্টরূপে পুনরায় ব্যবহার করা উচিত, আপনার পদ্ধতিটি সংজ্ঞায়নের পরে ট্রিপল কোট টাইপ করুন এবং এন্টার টিপুন। jetbrains.com/pycharm/help/creating-docamentation-comments.html

— ফিলিপ আলমেডা

সর্বাধিক বিস্তৃত উত্তরের মধ্যে ইতিহাসের বোধ এবং বর্তমানের সেরা অনুশীলন অন্তর্ভুক্ত রয়েছে। এখন আমাদের কেবলমাত্র একটি নতুন "সেরা" ফর্ম্যাটের দিকে সম্প্রদায়ের গতির কিছুটা ধারণা এবং নতুন থেকে অন্য সকলের থেকে মাইগ্রেশন সরঞ্জাম তৈরির দিকে কিছু অতিরিক্ত সম্প্রদায়ের প্রচেষ্টা দরকার, যাতে আমরা বাস্তবে সর্বোত্তম অনুশীলনকে বিকশিত করতে পারি।

— ববহাই

ইয়ো @daouzli শৈলী লিঙ্কটি Google 404. আমি ভান এই এক সঠিক। আপনি স্ফিংস গুগল শৈলীর উদাহরণও যুক্ত করতে পারেন । দুর্দান্ত উত্তর বিটিডব্লিউ। সম্পাদনা: আমি নিজেই আপনার উত্তর সম্পাদনা করেছি।

— ভাই

ভাল উত্তর. পাইচার্ম (জেটব্রেইনস) -এ আপনি ডিফল্ট ডকাস্ট্রিং ফর্ম্যাটটি কোথায় পরিবর্তন করতে পারবেন তা বলার সাহস আমি করছি: সেটিংস -> সরঞ্জাম -> পাইথন ইন্টিগ্রেটেড সরঞ্জাম -> ডকস্ট্রিং ফর্ম্যাট। শুভকামনা!

— জ্যাকসন

আমি অবাক হয়েছি প্রথম পাঠ্য রেখা সম্পর্কে নুন মন্তব্য করেছেন: বর্তমানে এটি কঠোরভাবে সঠিকভাবে বলছে তবে আমার মনে হয় পছন্দসই উপায়টি ট্রিপল কোটসের ঠিক পরে প্রথম লাইনে স্থাপন করা। পিইপি 8 এবং পিইপি 257 তাদের প্রায় সব উদাহরণে এটি করে। পিইপি 287 এটি আপনার পথে করে তবে আমার অভিজ্ঞতাতে এটি সাধারণ নয় common

— ল্যাপিনট

Answer 2

গুগল শৈলী গাইড একটি চমৎকার পাইথন শৈলী গাইড রয়েছে। এটি পঠনযোগ্য ডকস্ট্রিং সিনট্যাক্সের জন্য সম্মেলনগুলি অন্তর্ভুক্ত করে যা পিইপি -257 এর চেয়ে ভাল দিকনির্দেশনা সরবরাহ করে। উদাহরণ স্বরূপ:

def square_root(n):
    """Calculate the square root of a number.

    Args:
        n: the number to get the square root of.
    Returns:
        the square root of n.
    Raises:
        TypeError: if n is not a number.
        ValueError: if n is negative.

    """
    pass

আমি এই প্রসারিত ডকুমেন্টেশন টিউটোরিয়ালে বর্ণিত হিসাবে আর্গুমেন্টে টাইপ তথ্য অন্তর্ভুক্ত করার জন্য এটি প্রসারিত করতে চাই । উদাহরণ স্বরূপ:

def add_value(self, value):
    """Add a new value.

       Args:
           value (str): the value to add.
    """
    pass

Comments

আমি "ডকাস্ট্রিংগুলিতে স্বাক্ষর" খুঁজে পাই fully স্টাইলটি অত্যন্ত মারাত্মকভাবে অপ্রয়োজনীয় এবং শব্দভাণ্ডার। পাইথন 3+ এর জন্য, ফাংশন টীকাগুলি এটি করার জন্য আরও পরিষ্কার উপায়। আরও খারাপতর যদি এটি সিউডো-স্ট্রং-প্রকারগুলি ব্যবহার করে: হাঁসের টাইপিংয়ের সাথে পাইথন আরও ভাল।

— ইভপোক

হ্যাঁ, তবে কমপক্ষে এটি কোন ধরণের হাঁসের আশা করা যায় তার একটি ইঙ্গিত দেয়, এবং বেশিরভাগ

— দেবগণ

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

— ওড্রাএইনকোড

@ নাথান, গুগলের স্টাইল গাইড এমন মন্তব্যগুলির প্রস্তাব দিচ্ছে যা ঘোষণার চেয়ে বর্ণনামূলক, যেমন "" বিগ টেবিল থেকে সারি আনুন "ওভারের উপরে" একটি বিগ টেবিল থেকে সারিগুলি আনে "। সুতরাং, "গণনা ..." কে "গণনা ..." এ পরিবর্তন করা আপনার মন্তব্যটিকে বাকী মন্তব্যের সাথে আরও সামঞ্জস্য করবে, যেমন "রিটার্নস" এবং "উত্থাপন"।

— gwg

নীট: গুগল স্টাইল অনুসরণ করে,

— আবশ্যকীয়

Answer 3

PEP-8 এর চেয়ে অনেক বেশি বিশদ সহ ডকস্ট্রিং কনভেনশনগুলি PEP-257 এ রয়েছে।

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

আমি সর্বদা ডক্টাস্টিংগুলিকে অন্তর্ভুক্ত করে থাকি, কারণ তারা কীভাবে ফাংশনটি ব্যবহার করতে হয় এবং কীভাবে এটি খুব দ্রুত কাজ করে তা প্রদর্শন করার ঝোঁক থাকে।

আমি স্ট্রিংয়ের দৈর্ঘ্য নির্বিশেষে জিনিসগুলিকে সামঞ্জস্য রাখতে পছন্দ করি। আমি পছন্দ করি কীভাবে কোডটি দেখতে হয় যখন ইন্ডেন্টেশন এবং স্পেসিং সামঞ্জস্য হয়। এর অর্থ, আমি ব্যবহার করি:

def sq(n):
    """
    Return the square of n. 
    """
    return n * n

ওভার:

def sq(n):
    """Returns the square of n."""
    return n * n

এবং লম্বা ডকাস্ট্রিংগুলিতে প্রথম লাইনে মন্তব্য করা বন্ধ রাখে:

def sq(n):
    """
    Return the square of n, accepting all numeric types:

    >>> sq(10)
    100

    >>> sq(10.434)
    108.86835599999999

    Raises a TypeError when input is invalid:

    >>> sq(4*'435')
    Traceback (most recent call last):
      ...
    TypeError: can't multiply sequence by non-int of type 'str'

    """
    return n*n

অর্থ আমি এমন ডক্টরিস্টগুলি খুঁজে পেয়েছি যা এই জাতীয়ভাবে অগোছালো হতে শুরু করে।

def sq(n):
    """Return the squared result. 
    ...

Comments

নোট করুন যে পিইপি -8 বিশেষভাবে বলেছে যে ডকাস্ট্রিংগুলি বর্ণনার পরিবর্তে কমান্ড / নির্দেশাবলী হিসাবে লেখা উচিত। """Return the squared result"""বরং """Returns the squared result"""। যদিও ব্যক্তিগতভাবে, আমি পিইপি যা বলে তা সত্ত্বেও টিম এখানে কীভাবে আছে তা লিখি।

— ক্যাম জ্যাকসন

আমি সেই পরামর্শের সাথেও একমত নই (অত্যাবশ্যক কালটি ব্যবহার করে) কারণ এটি একটি বাক্যটির চেয়ে দীর্ঘতর যে কোনও কিছুর জন্য বিশ্রী লাগছে। তদতিরিক্ত, আপনি একটি ফাংশন বর্ণনা করছেন, পাঠককে কী করবেন তা বলছেন না।

— এম কে 12

দ্রষ্টব্য: বর্ণনামূলক ডকাস্ট্রিংয়ের পরিবর্তে ব্যবস্থাপত্রের স্পেসিফিকেশনটি পিইপি -8 নয়, পিইপি 257-এ প্রদর্শিত হবে । আমি জাভার একটি traditionতিহ্য থেকে এসেছি, যেখানে আমি ফাংশনগুলি বর্ণনা করছি, তবে শেষ পর্যন্ত আমি যখন আমার প্রোগ্রামিং দৃষ্টান্তটি অবজেক্ট-ভিত্তিক থেকে প্রক্রিয়াভিত্তিক দিকে নিয়ে যেতে শুরু করি তখন আবশ্যক কালটি ব্যবহার শুরু করি। এবং যখন আমি পাইককোকে সাক্ষরতা-প্রোগ্রামিং-স্টাইলের ডকুমেন্টেশন তৈরি করতে শুরু করি তখন এটি খুব স্পষ্ট হয়ে ওঠে যে কেন অত্যাবশ্যক কালকে পরামর্শ দেওয়া হয়েছিল। আপনার দৃষ্টান্তের উপর ভিত্তি করে আপনার চয়ন করা উচিত।

— karan.dodia

অপরিহার্য একটি ব্যাকরণগত মেজাজ । (দুঃখিত।)

— ডেনিস ড্র্রেসার

@ এম কে 12 গিট কমিট বার্তাগুলিকেও বর্ণনার পরিবর্তে আদেশ হিসাবে লেখা উচিত। এবং তারা একটি কোড পরিবর্তনকে " বর্ণনা " করছে , "পাঠককে কী করতে হবে তা বলছেন না"। সুতরাং আমি মনে করি এটি কমান্ড হিসাবে বিবরণ লিখতে কেবল কনভেনশন।

— onepiece

Answer 4

যেমন পরিষ্কারভাবে কেউ এটি উল্লেখ করেনি: আপনি নম্পি ডক্ট্রিং স্ট্যান্ডার্ডও ব্যবহার করতে পারেন । এটি বৈজ্ঞানিক মহলে ব্যাপকভাবে ব্যবহৃত হয়।

• বিন্যাসের স্পেসিফিকেশন numpy একসঙ্গে থেকে একটি সঙ্গে উদাহরণস্বরূপ
• এটি রেন্ডার করার জন্য আপনার কাছে স্পিংক্স এক্সটেনশান রয়েছে: নামপিডক
• এবং রেন্ডার করা ডকাস্ট্রিং দেখতে কতটা সুন্দর দেখতে পারে তার একটি উদাহরণ: http://docs.scipy.org/doc/numpy/references/generated/numpy.mean.html

গুগল-স্টাইলের ডকাস্ট্রিংগুলিকে পার্স করার জন্য নেপোলিয়ান স্পিংস এক্সটেনশন (@ নাথানের উত্তরে প্রস্তাবিত) এছাড়াও নম্পি-স্টাইলের ডক্ট্রিংকে সমর্থন করে এবং একটি সংক্ষিপ্ত তুলনা করে উভয়ের করে।

এটি কেমন দেখাচ্ছে তা ধারণা দেওয়ার জন্য একটি প্রাথমিক উদাহরণটি শেষ করুন:

def func(arg1, arg2):
    """Summary line.

    Extended description of function.

    Parameters
    ----------
    arg1 : int
        Description of arg1
    arg2 : str
        Description of arg2

    Returns
    -------
    bool
        Description of return value

    See Also
    --------
    otherfunc : some related other function

    Examples
    --------
    These are written in doctest format, and should illustrate how to
    use the function.

    >>> a=[1,2,3]
    >>> print [x + 3 for x in a]
    [4, 5, 6]
    """
    return True

Comments

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

— Semanino

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

— জোরিস

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

— জনাথন হার্টলি

Answer 5

পিইপি -8 হ'ল সরকারী পাইথন কোডিং স্ট্যান্ডার্ড। এটিতে ডকাস্ট্রিংয়ের একটি বিভাগ রয়েছে যা পিইপি -২ 257 বোঝায় - ডক্টাস্ট্রিংয়ের সম্পূর্ণ বিবরণ।

Comments

"আমি কীভাবে সঠিকভাবে প্যারামিটারগুলি নথি করা উচিত, প্রত্যাবর্তনের মানগুলি, উত্থাপিত ব্যতিক্রমগুলি ইত্যাদি" প্রসঙ্গে PEP-257 উল্লেখ করা একটি জোক - এটি তাদের সম্পর্কে একটি শব্দও বলে না (যদিও একটি কোড উদাহরণ কিছু দেখায়)। পাঠযোগ্যতা এবং বৈশিষ্ট্যগুলির ক্ষেত্রে আইএমএইচও গুগল ফর্ম্যাট একটি ভাল পছন্দ।

— সেমানিনো

Answer 6

এটি পাইথন; কিছু যায় । কীভাবে আপনার ডকুমেন্টেশন প্রকাশ করবেন তা বিবেচনা করুন । আপনার উত্স কোডের পাঠক ছাড়া ডকাস্ট্রিংগুলি অদৃশ্য।

লোকেরা ওয়েবে ডকুমেন্টেশনগুলি ব্রাউজ করতে এবং অনুসন্ধান করতে পছন্দ করে। এটি অর্জন করতে, ডকুমেন্টেশন সরঞ্জাম স্পিংক্স ব্যবহার করুন । পাইথন প্রকল্পগুলি নথিভুক্ত করার জন্য এটি ডি-ফ্যাক্টো স্ট্যান্ডার্ড। পণ্যটি সুন্দর - https://python-guide.readthedocs.org/en/latest/ এ একবার দেখুন । দস্তাবেজগুলি পড়ুন ওয়েবসাইটটি বিনামূল্যে আপনার ডক্সকে হোস্ট করবে।

Comments

আমি নিয়মিতভাবে ipythonএকটি লাইব্রেরি পরীক্ষা-চালনার জন্য ব্যবহার করি এবং এটি ডকাস্ট্রিংগুলি মৃতকে সহজ করে তোলে - আমাকে যা টাইপ করতে হয় তা হ'ল your_module.some_method_im_curious_about?এবং আমি ডকাস্ট্রিং সহ প্রতিটি সুন্দর প্রিন্টআউট পাই।

— থানাটোস

কোনও লাইব্রেরি বা কোনও এপিআইর ব্যবহারকারী বা যারা একটি প্লাগইন লিখছেন তারা সম্ভবত কোডটি দেখবেন এবং এটি উপলব্ধি করা প্রয়োজন। আমি জাভা বা সি # এর চেয়ে পাইথনে মন্তব্যগুলি অনেক বেশি গুরুত্বপূর্ণ মনে করি কারণ প্রকারগুলি ঘোষিত হয় না। মন্তব্যগুলি কি ধরণের হাঁসগুলি পাস এবং ফিরে দেওয়া হচ্ছে তা মোটামুটি ধারণা দিলে এটি অনেকটা সহায়তা করে। (অন্যথায়, আপনাকে অবশ্যই সমস্ত কোডটি হাঁটাতে হবে এবং ট্যালাই আপ করতে হবে যে প্রদত্ত প্যারামিটারটি অবশ্যই এখানে পুনরাবৃত্ত হতে হবে ... সেখানে সূচকে সমর্থন করুন ... শেষে সংখ্যার বিয়োগকে সমর্থন করুন ... আহা! এটি মূলত একটি int অ্যারে। একটি মন্তব্য সাহায্য করেছে!)

— জন Coombs

এহ, না ডক্টরিংগুলি অদৃশ্য নয় এবং এটি কিছুটা বিষয়। আপনি যদি helpডকুমেন্টেড ফাংশন / পদ্ধতি / ক্লাসে ফাংশনটি চালান তবে আপনি ডকাস্ট্রিংটি দেখতে পাবেন (এবং কেবলমাত্র সংকলিত মডিউলটিতে অ্যাক্সেস থাকলেও আপনি এটি করতে পারেন)। ব্যক্তিগতভাবে আমি মনে করি ডক্ট্রিং কনভেনশন বাছাই করার সময় এটির বিষয়টি মাথায় রাখা উচিত (যেমন এটি যেমনটি পড়ার ইচ্ছা রয়েছে)।

— ই

Answer 7

আমি PEP-257 এবং প্যারামিটার, রিটার্ন ইত্যাদির বিবরণ দেওয়ার জন্য নম্পি ডকস্ট্রিং স্ট্যান্ডার্ডের বিরুদ্ধে আপনার ডকাস্ট্রিংগুলি পরীক্ষা করার জন্য ভ্লাদিমির কেলেশেভের পেপ 257 পাইথন প্রোগ্রামটি ব্যবহার করার পরামর্শ দিচ্ছি

পেপ 257 আপনি স্ট্যান্ডার্ড থেকে তৈরি বৈচিত্রের প্রতিবেদন করবেন এবং এটি পাইলট এবং পেপ 8 এর মতো বলে।

Comments

"আমি কীভাবে সঠিকভাবে প্যারামিটারগুলি নথি করা উচিত, প্রত্যাবর্তনের মানগুলি, উত্থাপিত ব্যতিক্রমগুলি ইত্যাদি" প্রসঙ্গে PEP-257 উল্লেখ করা একটি জোক - এটি তাদের সম্পর্কে একটি শব্দও বলে না (যদিও একটি কোড উদাহরণ কিছু দেখায়)। নুমপি ফর্ম্যাট আইএমএইচও অনেক বেশি উল্লম্ব স্থান নেয় যা ওয়াইডস্ক্রিন মনিটরের ক্ষেত্রে খুব কমই থাকে (আপনি যদি 90 ডিগ্রি দ্বারা পরিবর্তিত একটি ব্যবহার না করেন তবে আমার ধারণা বেশিরভাগ লোকেরা করেন না) সুতরাং, আইএমএইচও গুগল ফর্ম্যাট পঠনযোগ্যতা এবং বৈশিষ্ট্যগুলির ক্ষেত্রে একটি ভাল পছন্দ।

— Semanino

@ সিমেনিনো আমি পেপ 257 প্রোগ্রামের প্রসঙ্গে নম্পি ডক্ট্রিং স্ট্যান্ডার্ডের কথা উল্লেখ করছি - পিইপি 257 নয়। সেই প্রোগ্রামটিকে এখন পাইডোকস্টাইল বলা হয়। পাইডোস্টাইল আপনাকে কিছু নমপিডোক চেকগুলি করার অনুমতি দেয়, উদাহরণস্বরূপ, pydocstyle --select=D4 tmp.pyবিভাগের নামকরণ সহ অনেকগুলি ডাস্ট্রিং সামগ্রী সামগ্রী পরীক্ষা করে।

— ফিন অরূপ নীলসন