python中的內置屬性__doc__和__name__

一、__doc__屬性

前言

 __doc__ 為python模塊的內置屬性【使用 方法名.__doc__ 調用】，__doc__ 為模塊字符串，模塊字符串寫在Python文件的第一行，三個引號包含起來的字符串。

編寫文檔字符串的原因

因為規范的書寫文檔字符串可以通過sphinx等工具自動生成文檔。

文檔字符串的風格

①plain

# Plain
def foo1(a, b):
    """

    """
    return a + b


if __name__ == '__main__':
    print(foo1.__doc__)

運行結果：

②Epytext

# Epytext
def foo(a, b):
    """
    @param a:
    @param b:
    @return:
    """
    return a + b


if __name__ == '__main__':
    print(foo.__doc__)

運行結果：

 ③reStucturedText

# reStructuredText
def foo2(a, b):
    """
    :param a:
    :param b:
    :return:
    """
    return a + b


if __name__ == '__main__':
    print(foo2.__doc__)

運行結果：

④Numpy

# Numpy
def foo3(a, b):
    """
    Parameters
    ----------
    a
    b

    Returns
    -------

    """


if __name__ == '__main__':
    print(foo3.__doc__)

運行結果：

⑤Google

# Google
def foo4(a, b):
    """
    Args:
        a:
        b:

    Returns:

    """
    return a + b


if __name__ == '__main__':
    print(foo4.__doc__)

運行結果：

⑥Pycharm設置

settings->Tools->python integrated tools ->Docstrings->Docstring format

二、__name__屬性

① __name__  是屬於 python 中的內置類屬性，代表對應程序名稱。

②當 __name__ 在當前執行的文件中使用時，它的值為 __main__ ；但是當 __name__ 在被調用的模塊中時，其值為被調用文件所在的路徑。

③ __name__ 內置屬性的實際應用。

在編寫python程序時，經常是功能模塊和業務邏輯模塊分離，在寫功能函數時，經常要進行調試函數是否正常，此時可以直接在功能模塊最下面加上：

if __name__ == '__main__':
    # 需要調試的內容
    pass

這樣就可以在下方直接來測試函數的功能了。

同時在其他模塊來調用這些函數時，由於此時 if 語句不成立，所以此時將不會執行下面的代碼塊；也就是說在在調用其他模塊時，被調用的模塊下方的 if 函數將不會被執行從而不會影響整個程序的正常使用。