• Python写代码的时候为什么要注释?Sun因此被Oracle收购


    导读:

    此块分为:1.注释的重要性

                    2.如何正确注释

     

    注释的重要性

    在我们看代码的时候,会遇到很多看不懂得代码,特别是在做项目的时候,代码的注释以及命名习惯的重要性就有了为什么这么说呢?

    因为在很多情况下,你在代码出错的时候,注释可以给你更快的找到错误的位置,方便你找到更好的解决方法!在项目做项目的时候,如果注释没有写,而导致一个项目无法在规定的时间内完成的案例不在少数, 在语言出现的初期,很多公司因为代码没有注释和命名不规范而倒闭,就比如太阳(sun)公司,说这个可能大家不了解,但是 JAVA这门语言大家都知道吧!后来被Oracle收购了,这只是其中一个比较显著的例子罢了!

    那么,很多种语言的注释方法几乎只有  #  或者  / /   ,但是Python代码的注释方法有多种

    第一种

     ' ' ' 注释内容  ' ' ' (用于注释大量、多行的内容)

    第二种

    ' ' 注释内容 ' '(方法自己研究)

    第三种

    # 单行注释 或者完成特定的功能

    # -*- coding: UTF-8 -*- 

    从Python3开始,Python默认使用UTF-8编码,所以Python3.x的源文件不需要特殊声明UTF-8编码。

    分享一个学习的群,里面有很多的学习书籍,文件,对于入门的小伙伴帮助非常大!

    Python学习资料:链接

    如何正确的写注释

    1. 注释不宜太多也不能太少,注释语言必须准确、简洁、易懂。

    2.注释条件:

        基本注释(必须加) 

            (a)    类(接口)的注释 

            (b)    构造函数的注释 

            (c)     方法的注释 

            (d)    全局变量的注释 

            (e)    字段/属性的注释 

    3. 特殊必加注释(必须加)

            (a)    典型算法必须有注释。

            (b)    在代码不明晰处必须有注释。 

            (c)     在代码修改处加上修改标识的注释。

            (d)    在循环和逻辑分支组成的代码中加注释。

            (e)    为他人提供的接口必须加详细注释。

    想要获取更多学习信息欢迎加入

  • 相关阅读:
    怎么查看京东店铺的品牌ID
    PPT编辑的时候很卡,放映的时候不卡,咋回事?
    codevs 1702素数判定2
    codevs 2530大质数
    codevs 1488GangGang的烦恼
    codevs 2851 菜菜买气球
    hdu 5653 Bomber Man wants to bomb an Array
    poj 3661 Running
    poj 1651 Multiplication Puzzle
    hdu 2476 String Painter
  • 原文地址:https://www.cnblogs.com/CoXieLearnPython/p/9098207.html
Copyright © 2020-2023  润新知