在团队协作处理 Excel 数据时,批注(Comment)是常用的沟通工具,用户可以在单元格上附加说明、备注或审核意见,而不影响原始数据。通过编程方式管理 Excel 批注,可以实现批量添加说明、自动标注数据异常、统一格式风格等操作。本文介绍如何使用 Python 借助 Spire.XLS for Python 库在 Excel 文件中添加、编辑、格式化和删除批注。
环境准备
使用 Spire.XLS for Python 操作 Excel 文件,安装命令:安装完成后导入相关模块即可。
添加基础批注
最基础的批注操作是为指定单元格添加文本说明。通过访问单元格的 Comment 属性,直接设置批注内容:- from spire.xls import *
- from spire.xls.common import *
- workbook = Workbook()
- sheet = workbook.Worksheets[0]
- sheet.Range["A1"].Text = "产品A"
- sheet.Range["A1"].Comment.Text = "该产品已停产,数据仅供参考"
- sheet.Range["A1"].Comment.Visible = True
- workbook.SaveToFile("BasicComment.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 Comment.Text 属性设置纯文本批注内容,Visible 控制批注是否默认可见(设为 False 时批注仍存在,鼠标悬停才显示)。
添加带作者信息的批注
多人协作时区分作者很有必要。使用 AddComment() 方法创建批注对象,手动拼接作者名和正文:- from spire.xls import *
- from spire.xls.common import *
- workbook = Workbook()
- workbook.LoadFromFile("DataFile.xlsx")
- sheet = workbook.Worksheets[0]
- cell_range = sheet.Range["C1"]
- comment = cell_range.AddComment()
- comment.Width = 200
- comment.Visible = True
- author = "张经理"
- text = "本季度数据已核实,可以发布。"
- comment.Text = author + ":\n" + text
- font = workbook.CreateFont()
- font.FontName = "Tahoma"
- font.KnownColor = ExcelColors.Black
- font.IsBold = True
- comment.RichText.SetFont(0, len(author), font)
- workbook.SaveToFile("CommentWithAuthor.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 RichText.SetFont(0, len(author), font) 对作者名范围应用粗体,与正文明确区分。
创建富文本批注
批注中需要不同颜色或样式区分信息层级时,使用富文本格式:- from spire.xls import *
- from spire.xls.common import *
- workbook = Workbook()
- sheet = workbook.Worksheets[0]
- font_green = workbook.CreateFont()
- font_green.FontName = "Arial"
- font_green.Size = 11
- font_green.KnownColor = ExcelColors.LightGreen
- font_blue = workbook.CreateFont()
- font_blue.FontName = "Arial"
- font_blue.Size = 11
- font_blue.KnownColor = ExcelColors.LightBlue
- cell_range = sheet.Range["B12"]
- cell_range.Text = "销售数据"
- cell_range.RichText.SetFont(0, 16, font_green)
- cell_range.Comment.RichText.Text = "已审核: 数据正常"
- cell_range.Comment.RichText.SetFont(0, 4, font_green)
- cell_range.Comment.RichText.SetFont(5, 9, font_blue)
- workbook.SaveToFile("RichTextComment.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 RichText.SetFont(start_index, end_index, font) 对批注文本不同区段应用不同字体,适合区分状态标签与详细说明。
设置批注背景颜色
修改批注的填充属性,为批注框设置背景色:- from spire.xls import *
- from spire.xls.common import *
- workbook = Workbook()
- sheet = workbook.Worksheets[0]
- cell_range = sheet.Range["A1"]
- cell_range.Comment.Text = "重要提示:此数据需要复核"
- font = workbook.CreateFont()
- font.FontName = "Arial"
- font.Size = 11
- font.KnownColor = ExcelColors.Orange
- cell_range.Comment.RichText.SetFont(0, len(cell_range.Comment.Text) - 1, font)
- cell_range.Comment.Fill.FillType = ShapeFillType.SolidColor
- cell_range.Comment.Fill.ForeColor = Color.get_SkyBlue()
- cell_range.Comment.Visible = True
- workbook.SaveToFile("CommentFillColor.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 Fill.FillType 设为 ShapeFillType.SolidColor,通过 ForeColor 指定背景色,适合用颜色标记优先级或类别。
调整批注位置、大小与对齐方式
批注框位置、尺寸和文本对齐方式可直接控制:- from spire.xls import *
- from spire.xls.common import *
- workbook = Workbook()
- sheet = workbook.Worksheets[0]
- sheet.Range["G5"].Text = "数据项"
- comment = sheet.Range["G5"].Comment
- comment.IsVisible = True
- comment.Height = 150
- comment.Width = 300
- comment.RichText.Text = "审核备注:\n此项数据来源于系统导出,已经过初步校验。"
- comment.TextRotation = TextRotationType.LeftToRight
- comment.Top = 20
- comment.Left = 40
- comment.VAlignment = CommentVAlignType.Center
- comment.HAlignment = CommentHAlignType.Justified
- workbook.SaveToFile("CommentPosition.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 关键属性说明:Height/Width 控制像素尺寸;Top/Left 控制相对工作表的位置坐标;VAlignment 可选 Top、Center、Bottom;HAlignment 可选 Left、Center、Right、Justified。
为批注添加图片背景
除了纯色,还可以用图片作为批注框背景(如公司 Logo 或状态图标):- from spire.xls import *
- from spire.xls.common import *
- workbook = Workbook()
- sheet = workbook.Worksheets[0]
- sheet.Range["C6"].Text = "负责人"
- comment = sheet.Range["C6"].AddComment()
- image = Stream("Logo.png")
- comment.Fill.CustomPicture(image, "logo.png")
- comment.Visible = True
- workbook.SaveToFile("CommentWithImage.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 Fill.CustomPicture() 接受图片流和图片名称,加载的图片作为批注框背景填充。
读取和编辑已有批注
对于已有 Excel 文件,遍历批注集合读取或修改:- from spire.xls import *
- workbook = Workbook()
- workbook.LoadFromFile("ExistingFile.xlsx")
- sheet = workbook.Worksheets[0]
- comment_text = sheet.Range["A1"].Comment.Text
- print("批注内容:", comment_text)
- rtf_text = sheet.Range["A2"].Comment.RichText.RtfText
- print("RTF 内容:", rtf_text)
- workbook.Dispose()
复制代码 编辑已有批注:通过 Comments 索引集合访问并修改属性:- comment = sheet.Comments[0]
- comment.Text = "批注内容已更新"
复制代码
控制批注显示和隐藏
单独控制可见性,无需删除即可隐藏或重新显示:- from spire.xls import *
- workbook = Workbook()
- workbook.LoadFromFile("CommentFile.xlsx")
- sheet = workbook.Worksheets[0]
- sheet.Comments[1].IsVisible = False
- sheet.Comments[2].IsVisible = True
- workbook.SaveToFile("CommentVisibility.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 适合在打印或演示时隐藏审核批注。
删除批注
当批注不再需要时,彻底移除:- from spire.xls import *
- workbook = Workbook()
- workbook.LoadFromFile("CommentFile.xlsx")
- sheet = workbook.Worksheets[0]
- sheet.Comments[1].Remove()
- workbook.SaveToFile("CommentRemoved.xlsx", ExcelVersion.Version2013)
- workbook.Dispose()
复制代码 遍历 sheet.Comments 并逐一调用 Remove() 可清除所有批注。
总结
本文介绍了使用 Python 管理 Excel 批注的常用操作,包括:添加基础文本批注和带作者信息的批注;使用富文本设置不同颜色和样式的批注内容;设置批注背景颜色和图片背景;调整批注位置、大小和文本对齐方式;读取、编辑、隐藏和删除已有批注。这些操作覆盖了批注管理的主要场景。在此基础上,可进一步结合数据校验逻辑自动添加批注,或批量处理多个 Excel 文件中的批注内容,构建完善的自动化工作流。 |