Python에서 주석 문서를 빠르게 생성하는 방법

파이썬에서 주석 문서를 빠르게 생성하는 방법

오늘은 주의만 하면 되는 간단하고 작은 세부 사항을 알려드리겠습니다. 주석 문서를 쉽게 생성할 수 있고, 주석이 있는지도 확인할 수 있습니다. 우리가 작성한 클래스 메소드 참조 이름이 중복되었습니다. 다른 전문 전문가가 작성한 문서를 보면 걱정하지 마십시오. Python이 기본적으로 만족스러운 문서를 생성하도록 할 수 있습니다. 둘째, 코드의 전반적인 가독성을 높일 수 있습니다. 코드의 전체 구조가 더 명확해져서 인계 중에 많은 문제를 줄일 수 있습니다. 다른 동료가 작업을 맡을 때 이것이 무엇인지, 그게 무엇인지 한 줄씩 묻지 않을 것입니다. 통합에서 때로는 고객에게 간단한 지침을 제공하기 위한 설명 문서로 사용될 수 있습니다(주로 BOSS용). 그러면 아래의 간단한 코드 형식을 살펴보겠습니다. 주석 위치와 함수 이름, 클래스 이름은 모두 __all__과 관련되어 있습니다.

#!/usr/bin/env python
# -*-coding:utf-8 -*-


'''
文档快速生成注释的方法介绍,首先我们要用到__all__属性
在Py中使用为导出__all__中的所有类、函数、变量成员等
在模块使用__all__属性可避免相互引用时命名冲突
'''
__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']


class Login:
    '''
    测试注释一可以写上此类的作用说明等
    例如此方法用来写登录
    '''

    def __init__(self):
        '''
        初始化你要的参数说明
        那么登录可能要用到
        用户名username
        密码password
        '''
        pass

    def check(self):
        '''
        协商你要实现的功能说明
        功能也有很多例如验证
        判断语句，验证码之类的
        '''
        pass


class Shop:
    '''
    商品类所包含的属性及方法
    update改/更新
    find查找
    delete删除
    create添加
    '''

    def __init__(self):
        '''
        初始化商品的价格、日期、分类等
        '''
        pass

    def upDateIt(self):
        '''
        用来更新商品信息
        '''
        pass

    def findIt(self):
        '''
        查找商品信息
        '''
        pass

    def deleteIt(self):
        '''
        删除过期下架商品信息
        '''
        pass

    def createIt(self):
        '''
        创建新商品及上架信息
        '''
        pass

if __name__=="__main__":
    import pythonzhushi
    print help(pythonzhushi)

여기서 py의 이름은 현재 작업 중인 py의 이름과 동일해야 한다는 점을 강조해야 합니다. on(여기서 만든 py의 이름은 pythonzhushi이고 최종 가져오기도 이 이름입니다). 왜냐하면 다음 테스트에서는 가져오기가 자체이기 때문입니다. 가져오기 이름과 도움말(이름) 및 파일 이름은 반드시 일관성을 유지하십시오. 보다 직관적으로 이해하려면 아래 그림을 보십시오.

물론 여기서는 Python의 일반적인 가져오기 방법을 사용합니다. pythonzhushi

물론 저는 여전히 다음을 보여주기 위해 사진을 사용합니다.

한눈에 알 수 있으므로 우리가 해야 할 주석 문서를 가져올 수도 있다는 것, 도움말 도움말 방법 Readme 문서의 설명과 유사하게 이 파일에 포함된 클래스와 함수를 보는 데 도움이 되는 간단한 도움말 문서입니다. 마지막으로 마스킹 효과를 살펴보겠습니다.

저희 프로그램의 사용설명서를 간단하게 인쇄할 수 있나요? 다음 단계에서 직접 작성할 수 있습니다. 텍스트에 붙여넣어 추가 정보의 문서 설명을 완성하세요. 테스트 후 몇 가지 참고 사항이 있습니다. #과 같은 주석을 작성하려면 def에 작성하지 마세요. release하지만 그 위의 위치에 쓰십시오. 이는 데코레이터와 유사합니다. 반대로 def 외부에 ''' 따옴표를 쓰지 마십시오. 표시 효과가 없습니다. 여러분, 서둘러서 시도해 보세요. 시청해 주셔서 감사합니다. .