在Python中,批注通常是指代码中的注释,用于解释代码的功能、目的或者需要注意的事项。Python支持两种注释方式:单行注释和多行注释。
单行注释
使用``符号开头,注释内容紧随其后直到该行结束。
这是一个单行注释print("Hello, World!")
多行注释
使用三个单引号`'''`或三个双引号`"""`将注释内容括起来,可以跨越多行。
'''这是一个多行注释可以跨越多行'''print("Hello, World!")
行内注释
注释可以添加到代码行的开头,通常用于简短的解释或提醒。
这是一个行内注释print("Hello World")
模块、函数、方法和文件头注释

模块级别:在文件顶部,用于描述整个模块的功能和目的。
函数和方法级别:在函数或方法定义的下一行,用于解释函数或方法的作用。
文件头注释:在文件顶部,通常包含项目名称、作者、创建日期等信息。
示例
!/usr/bin/env pythonencoding: utf-8CONFIDENTIAL --- CUSTOM STUDIOSProject Name: My Python ScriptAuthor: Your NameDate: 2024-05-01导入所需库from PIL import Image, ImageDraw, ImageFontimport os创建示例图片文件夹if not os.path.exists('annotated_images'):os.makedirs('annotated_images')加载要处理的图片def load_image(image_path):try:return Image.open(image_path)except Exception as e:print(f"哎呀,加载图片出错啦:{e}")return None文字标注功能def add_text_annotation(image, text, position, font_size=30, color="red"):创建一个可以在图片上绘图的对象draw = ImageDraw.Draw(image)加载微软雅黑字体,找不到就用默认的try:font = ImageFont.truetype("msyh.ttc", font_size)except:font = ImageFont.load_default()绘制文字,可以自定义位置和颜色draw.text(position, text, fill=color, font=font)return image矩形框标注功能def add_rectangle_annotation(image, rect, color="red"):创建一个可以在图片上绘图的对象draw = ImageDraw.Draw(image)绘制矩形框draw.rectangle(rect, outline=color, width=2)return image
在编写批注时,请确保它们简洁明了,并能够清楚地解释代码的意图和用途。这有助于其他开发者(或未来的你)快速理解代码的功能
