Word 文档注释添加指南：使用 Apache POI 轻松添加注释

2024-03-29 00:58:19

使用 Apache POI 在 Word 文档中添加注释：分步指南

引言

在文档协作中，添加注释对于澄清和反馈至关重要。Apache POI 是一个强大的 Java 库，可以操作 Microsoft Office 文件。本文将指导你使用 POI 向现有 Word 文档中添加注释，让你轻松地在文档中交流想法。

创建注释引用

注释引用是文档中文本位置的标记。使用 POI 创建注释引用如下：

XWPFParagraph paragraph = document.createParagraph();
XWPFRun run = paragraph.createRun();
XWPFCommentReference reference = run.createCommentReference();
reference.setId("my-comment-id");

创建注释

接下来，创建注释并设置其文本和作者信息：

XWPFComments comments = document.getDocComments();
XWPFComment comment = comments.createComment();
comment.setId("my-comment-id");
comment.setAuthor("John Doe");

XWPFParagraph commentParagraph = comment.createParagraph();
XWPFRun commentRun = commentParagraph.createRun();
commentRun.setText("My comment text");

应用文本标记

文本标记将文本包围起来以供注释，如下所示：

CTBody body = paragraph.getCTP().getBody();
CTMarkupRange commentRangeStart = body.addNewCommentRangeStart();
commentRangeStart.setId("my-comment-id");

CTMarkupRange commentRangeEnd = body.addNewCommentRangeEnd();
commentRangeEnd.setId("my-comment-id");

run.setText("This is the text to be commented");

关联注释引用与标记

关联注释引用和文本标记以便 Word 将注释与正确的文本联系起来：

CTMarkupRange startRange = body.getCommentRangeStartList().get(0);
CTMarkupRange endRange = body.getCommentRangeEndList().get(0);
reference.setId(startRange.getId());

startRange.setRef(reference.getId());
endRange.setRef(reference.getId());

保存文档

最后，保存文档以持久化注释：

FileOutputStream out = new FileOutputStream("commented-document.docx");
document.write(out);
out.close();

常见问题解答

如何从文档中删除注释？

删除注释引用的关联文本标记，然后从注释部分中删除注释。
可以在图表或图像中添加注释吗？

是的，你可以使用 ShapeComment 注释图表和图像。
如何更改注释的作者和文本？

更新 comment.setAuthor() 和 commentRun.setText() 以修改注释的作者和文本。
注释是否可以在不同的 Word 版本中兼容？

注释与 Word 版本兼容，但在较旧的版本中可能无法完全显示或编辑。
如何使用 Apache POI 添加其他类型的注释，如批注和脚注？

POI 支持多种注释类型，例如批注和脚注，通过调用类似的方法即可添加。