常我们需要在源代码中添加文字用来对进行代码解释说明，但这些文字并不是 Java 代码的语法，会导致编译出错。这时我们可以使用注释来完成这一事项！

在编译时，编译器会忽略注释的存在，就好像注释内容不存在一样。所以注释并不会导致编译出错，同时注释还方便编写者和其他人阅读源代码，加强对代码的理解。

Java中提供了三种注释方式：

（1）单行注释： // 注释内容

快捷键：【注释 ctrl+/ 】 、 【 取消注释 ctrl+/ 】

（2）多行注释 /* 注释内容 */

快捷键：【注释 ctrl+shift+/ 】 【取消注释 ctrl+shift+\ 】

（3）文档注释 /** 注释内容 */

文档注释和多行注释的作用基本相同，唯一的区别时文档注释可以使用javadoc.exe命令生成API文档。

建议写代码的时候先写思路，分析，步骤，然后再写代码。思路，分析，步骤使用注释放在源代码中。

为什么要添加程序注释？

（1）用于不要过于相信自己的理解能力！

（2）可读性第一，效率第二，软件开发需要团队合作，一个人写的代码需要被整个团队的其他人理解，

所以注释是必要的。

（3）代码即文档，程序源代码是程序文档的重要组成部分。软件里最重要的文档：源代码写规范。

释的作用:

在代码中加一些说明解释，方便程序员阅读

两种格式(提示:编译器在编译代码时，会忽略注释内容)

单行注释(//描述信息):通常放在一段代码的上方，或者一条语句的末尾，对该行代码说明

多行注释(/*描述信息*/):通常放在一段代码的上方，对该段整体代码的说明

案例

＃include<iostream>

using namespace std;

//1、单行注释

//2、多行注释

/*

main是程序的入口

每个程序都必须有这么一个函数

有且仅有一个

*/

int main() {

//此下行代码含义是在屏幕中输出hello world

cout<<"hello world"<<end1;

system("pause");

return 0;

铁老豆之前介绍Python字符串时，留了一个坑，那就是字符串多行书写的问题，现在不就来填坑了吗？在处理涉及多行文本的数据时，如何优雅且有效地书写多行字符串，能从侧面反映你是不是一个合格或者资深的Pythoner。那么废话不多说，钢铁老豆就给大家介绍一下Python中多行字符串的书写方法，然后总结一下他们各自的适用场景。

1.使用三重引号（Triple Quotes）

Python允许使用三重单引号（'''）或三重双引号（"""）来创建多行字符串，这是处理多行字符串中最直接且常用的方法。

text = '''这是一个例子
展示如何使用三重双引号
来创建多行字符串。'''

适用场景：

• 不忽略缩进、不忽略换行。
• 编写多行注释。
• 在代码中嵌入多行文本，如配置信息或错误消息。
• 当字符串内需要包含多个换行符时，这种方式既直观又易于实现。

2.使用反斜杠（Backslash）

在Python字符串中，反斜杠（\）是一个转义字符，用来插入那些字符串里本来无法包含的字符。通过在行尾添加反斜杠，可以实现多行字符串的连接，而不实际在字符串中加入换行符。

text = '这是另一个例子，展示如何使用反斜杠\
来连接多行字符串，同时不实际加入换行符。'

适用场景：

• 不忽略缩进、忽略换行。
• 当需要在源代码中分多行书写但结果字符串需要是单行时。
• 适用于需要遵循特定字符限制的编程环境。

3.使用括号

在Python中，括号（()）用于创建一个连续的表达式。这种方法可以用来连接多行字符串，同时保持代码的可读性。

text = ('这是一个例子，展示如何使用'
           '括号来连接多行字符串，'
           '同时保持代码的整洁。')

适用场景：

• 忽略缩进、忽略换行。
• 代码需要保持高度整洁和可读性。
• 当字符串分多个部分，且每部分代表独立的逻辑或信息。

4.使用textwrap.dedent + replace

虽然使用括号能忽略缩进、忽略换行，但是如果你书写和复制这些多行字符串时，处理额外的引号也并不算优雅，这时候，钢铁老豆就要祭出textwrap.dedent+replace大法啦！textwrap.dedent能在三重引号的基础上，统一去掉多余的悬停缩进，但是换行需要进一步使用replace来解决。

需要注意的是，textwrap.dedent只能去掉统一的悬停缩进，对于每行更多的缩进则仍然会保留在字符串里。

import textwrap
text = textwrap.dedent('''
    这是一个例子，展示如何使用
      textwrap.dedent来统一去掉多余的悬停缩进
         但是换行需要进一步使用replace来解决
''')
print(text)  # \n这是一个例子，展示如何使用\n  textwrap.dedent来统一去掉多余的悬停缩进\n     但是换行需要进一步使用replace来解决\n

text = textwrap.dedent('''
    这是一个例子，展示如何使用
      textwrap.dedent来统一去掉多余的悬停缩进
         但是换行需要进一步使用replace来解决
''').replace('\n', '')
print(text)  # 这是一个例子，展示如何使用  textwrap.dedent来统一去掉多余的悬停缩进     但是换行需要进一步使用replace来解决

适用场景：

• 保留三重引号书写多行字符串的便利性
• 忽略缩进、忽略换行

上面的这4种方法就是钢铁老豆常用的几种书写多行字符串的方法，各有各的特点和适用场景。学会书写多行字符串，不仅可以提高代码的可读性，还可以在不同的编程情境中提供更大的灵活性和效率。

欢迎点赞+收藏+评论+关注，每天学习一点Python小知识，无论基础、模块、数据分析、深度学习和Ai，总有你感兴趣的。我是钢铁老豆，一个30岁转行IT、自学成为算法工程师、想用Ai点亮孩子小小世界的Pythoner。