常我們需要在源代碼中添加文字用來對進行代碼解釋說明,但這些文字并不是 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中多行字符串的書寫方法,然后總結一下他們各自的適用場景。
Python允許使用三重單引號(''')或三重雙引號(""")來創建多行字符串,這是處理多行字符串中最直接且常用的方法。
text = '''這是一個例子
展示如何使用三重雙引號
來創建多行字符串。'''
適用場景:
在Python字符串中,反斜杠(\)是一個轉義字符,用來插入那些字符串里本來無法包含的字符。通過在行尾添加反斜杠,可以實現多行字符串的連接,而不實際在字符串中加入換行符。
text = '這是另一個例子,展示如何使用反斜杠\
來連接多行字符串,同時不實際加入換行符。'
適用場景:
在Python中,括號(())用于創建一個連續的表達式。這種方法可以用來連接多行字符串,同時保持代碼的可讀性。
text = ('這是一個例子,展示如何使用'
'括號來連接多行字符串,'
'同時保持代碼的整潔。')
適用場景:
雖然使用括號能忽略縮進、忽略換行,但是如果你書寫和復制這些多行字符串時,處理額外的引號也并不算優雅,這時候,鋼鐵老豆就要祭出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。
*請認真填寫需求信息,我們會在24小時內與您取得聯系。