注释和文档

作者: 朱兰Juran | 来源:发表于2022-05-25 07:55 被阅读0次

注释

注释是用于使代码更容易理解的代码的说明。它们不影响代码的运行。

在 Python 中,通过插入一个 # 来创建注释。该行后面的所有文本都被忽略。

例如:

x = 365

y = 7

# 这是一个注释

print(x % y) # 打印余数

# print (x // y)

# 注释不会影响程序运行

结果:

1

注:Python 没有通用的多行注释。


文档

Docstrings和注释的目的类似,因为它们旨在解释代码。但是,它们更具体,并且具有不同的语法。

它们是通过在函数的第一行下面放置一个包含函数说明的多行字符串来创建的。

def shout(word):

  """

  给一个词后面加一个感叹号

  并打印这个词

  """

  print(word + "!")

shout("spam")

尝试一下

结果:

spam!

与传统的注释不同,文档字符串在整个程序运行时保留。这允许程序员在运行时检查这些文档注释。

相关文章

  • Java基础之单行、多行、文档注释

    单行 //我是单行注释 多行 /* 我是多行注释 */ 文档注释 /** 我是文档注释 */ 文档注释和单行、多行...

  • java中的注释(Comment)

    java中的注释分为三种 单行注释 多行注释 文档注释 文档注释,会被编译,单行和多行注释不会被编译 例如这个文件...

  • java——帮助文档

    注释和嵌入式文档: 文档注释/** */ 独立文档以@开头 ,行内文档标签随意 javadoc只能为publ...

  • Groovy基本语法

    官方文档 注释(Comments) 和Java一样,支持单行(使用//)、多行(/* */)和文档注释(使用/**...

  • 2017-05-10

    单行注释、多行注释与文档注释的合理使用 单行注释、多行注释与文档注释的合理使用 单行注释:// 注释内容 多行注释...

  • JavaDoc和eclipse如何导出文档

    JavaDoc注释和eclipse如何导出文档 JavaDoc注释 Javadoc注释的用法 eclipse如何导...

  • 注释

    -//单行注释 -/*多行注释*/ -/**文档注释*/

  • 【Java补充】 Java文档注释

    Java文档注释 4.9 文档注释 运行javadoc可以生成HTML文档。 以专用的定界符 /**开始的注释,可...

  • 文档注释

    // 文档注释 // 快捷键 cmd + option + / /// <#Description#> /// /...

  • Java语言基础

    注释 -单行注释: //-多行注释: /* /-文档注释 : /* */ 命名 -类名:通常...

网友评论

    本文标题:注释和文档

    本文链接:https://www.haomeiwen.com/subject/woqeprtx.html