图形学图像处理跨平台【免费下载链接】SkiaSharpSkiaSharp is a cross-platform 2D graphics API for .NET platforms based on Googles Skia Graphics Library. It provides a comprehensive 2D API that can be used across mobile, server and desktop models to render images.项目地址https://gitcode.com/gh_mirrors/sk/SkiaSharp点击查看免费下载C# XML 文档注释///注释是 SkiaSharp 公共 API 面向使用者的权威文档来源托管构建会从这些注释生成编译器 XML并随引用程序集一起打包发布。本文围绕仓库内 api-docs 技能 的审查工作流文档 reviewing.md完整讲解如何对 SkiaSharp / HarfBuzzSharp 的源码 API 文档进行源码优先的审阅——从必读参考、七步审查流程、三类检查项到逐行机器可读的报告格式与严重性分级并辅以仓库源码实例佐证。审查的本质审阅///注释而非直接编辑 XML审查的目标是面向使用者的、准确的编译器 XML其真实来源是紧贴公共声明的 C#///注释块。因此审查对象是binding/或source/下的消费者可见公共声明及其///注释不是编译器生成的 XML 工件也不是 ECMA/mdoc 输出一次审查默认是**只报告report-only**的除非请求同时要求修正corrections修正时同样只改源码注释对于生成的绑定generated binding只能编辑其///注释 trivia随后重新生成并验证注释得以保留再运行 validation.md 中的构建与包校验。仓库事实本仓库没有 API 参考的 ECMA/mdoc 源、mdoc 引擎或docs子模块也没有占位文档工作流见 SKILL.md。mono/SkiaSharp-API-docs独立消费包/编译器 XML 与_DocsMedia并负责下游产出本仓库只负责源头注释。审查前的必读材料开始审查前必须通读四份参考文档它们分别规定了语法规则、严重性标准、已核实的领域事实与现代化示例 API参考文档提供的约束patterns.mdC# XML 注释语法、声明模式、参数/返回值/异常/交叉引用写法、富文本remarks与示例规范checklist.md发现项的分级标准CRITICAL / IMPORTANT / MINOR与报告格式skia-patterns.md已核实的领域事实颜色字节序、所有权/线程模型、结构体默认值、标准枚举编号、字符串填充/截断行为obsolete-api-map.md错误级废弃 API 及其现代化替代如SKPaint文本 API →SKFont审查过程中的事实主张必须回源验证SkiaSharp 与 HarfBuzzSharp 的约定保持独立不可互相套用例如SKColor是 ARGB0xAARRGGBB而hb_color_t是 BGRA0xBBGGRRAA同一标准编号在不同枚举中的含义也可能不同SmpteSt4281在SKColorspacePrimariesCicp里是 D-Cinema 基色在SKColorspaceTransferFnCicp里是 gamma≈2.6 的传递函数绝不能写成线性。Source-first 审查流程七步操作细则第 1 步划定范围将范围解析到binding/或source/下消费者可见的公共声明。按主题theme审查时除名称外还要依据用途纳入相关 API按变更 API审查时检查变更的公共声明本身而不是生成的 XML 工件。第 2 步先读声明与实现再看注释在阅读注释之前先读声明和实现逐项记录访问器get/set/init、参数、可空性、校验逻辑、异常、默认值、所有权、线程约束与重载行为。每一条与源码矛盾的事实都要给出path:line引用。例如 SKCanvas.cs 中[Obsolete (Use DrawText(string text, SKPoint p, SKTextAlign textAlign, SKFont font, SKPaint paint) instead., error: true)] public void DrawText (string text, SKPoint p, SKPaint paint) DrawText (text, p, paint.TextAlign, paint.GetLegacyFont (), paint);读实现会发现该重载内部委托给带SKTextAlign、SKFont的现代重载并经由paint.GetLegacyFont()从SKPaint合成字体——这正是注释中legacy text settings遗留文本设置的准确含义也是error: true使其成为编译错误的原因。第 3 步逐元素核对///结构依据 patterns.md 检查每个///元素summary、param、typeparam、returns、value、exception、remarks、example、cref与paramref。要点包括无内容的元素使用自闭合形式inheritdoc /、see langwordnull /不要仅为列表完整而添加空的 summary/param/returns/value/exception 元素param name…中的参数名必须与声明完全一致散文提及参数用paramref泛型参数用typeparamref布尔参数写 trueto…布尔返回值/属性值写 trueif…null/true/false使用see langword… /不用反引号或裸关键字仅文档化同一声明上真实发生的异常禁止把exception复制到无关成员上。第 4 步把示例当作代码来验证对每个示例解析当前源码中的每一个标识符、构造函数、方法重载、属性、可空结果与释放动作。可空工厂结果在解引用前必须判空using只能用于调用方拥有的对象。特别注意不得释放父对象拥有的对象SKDocument.BeginPage返回的 canvas 与SKSurface.Canvas由父对象拥有示例中不能Dispose。源码佐证SKDocument.cs 中BeginPage通过OwnedBy(..., this)注册父所有权SKSurface.cs 的Canvas属性注释写明the canvas for this surface不得使用错误级废弃 API文本示例必须使用SKFont形式的重载而非SKPaint遗留形式。对照 obsolete-api-map.mdSKCanvas.DrawText(string, float, float, SKPaint)SKCanvas.cserror: true与SKCanvas.DrawText(string, float, float, SKTextAlign, SKFont, SKPaint)SKCanvas.cs同名但签名不同——废弃重载是没有SKFont参数的那个。标准现代示例using var typeface SKTypeface.FromFamilyName(Arial); using var font new SKFont(typeface, 24); using var paint new SKPaint { Color SKColors.Black, IsAntialias true }; canvas.DrawText(Hello, 10, 40, SKTextAlign.Left, font, paint); float width font.MeasureText(Hello);废弃 API 与现代化 API 常共享方法名只能靠接收者类型与参数列表区分任何仅按名称的检查都会判错。第 5 步用源码而非直觉验证事实主张五条硬性规则约束描述必须反映代码实际行为——是抛异常、接受、填充pad、截断truncate还是钳制clamp。字符串解析类 API 常静默填充/截断不要想当然写必须恰好 N 个字符属性措辞与访问器匹配getter-only 以 Gets 开头可写属性以 Gets or sets 开头init访问器应描述为可在初始化期间设置默认值必须有源码初始值或其他具体源码证据零初始化结构体成员默认是0/false/null禁止把兄弟常量如SKDocument.DefaultRasterDpi的 72写成结构体属性的默认值原生布局需要原生头文件佐证标准声明需要成员自身枚举/值佐证对照 skia-patterns.md 中颜色通道顺序与命名后缀约定x后缀表示第四分量是填充而非 alpha如Rgb888xSkiaSharp 与 HarfBuzzSharp 约定保持区分不可互相迁移。第 6 步按源码位置与问题去重发现项按源码位置 问题类型去重并采用 checklist.md 中适用的最高严重级别。第 7 步请求修正时的操作如需修正直接修改源码注释对生成的绑定只编辑其///注释 trivia然后运行生成器回环并验证注释存活pwsh -NoLogo -NoProfile -File ./utils/generate.ps1 dotnet build binding/SkiaSharp/SkiaSharp.csproj绝不允许手改生成绑定的声明、interop 代码或实现随后按 validation.md 完成构建、编译器 XML 与包契约校验。三类审查检查项事实准确性Factual accuracy参数/返回值描述是否与可空性、校验、实际失败行为及确切重载匹配默认值指的是源码默认而非典型值属性摘要是否区分 getter-only 与可写行为所有权与线程声明是否与托管包装必要时含原生实现一致字节序、颜色通道、打包值与标准引用是否与 skia-patterns.md 中的已验证来源一致示例与备注Examples and remarks每个代码片段是否自包含、与当前 API 一致、可从所示导入/上下文直接编译可空工厂结果在解引用前是否判空using是否只包裹调用方拥有的对象SKSurface.Canvas与SKDocument.BeginPage返回的 canvas 是父拥有的示例不得释放文本示例是否使用SKFont形式而非错误级废弃的SKPaint形式同名现代重载仅在接收者与参数列表正确时才是有效的备注是否有用且有依据而非无支撑的对比或生命周期断言源码注释质量Source-comment qualitysummary是否有意义、语法正确、标点完整构造函数、属性、布尔值、langword、转义与cref形式是否正确参数名、泛型参数名与异常类型是否与声明完全一致inheritdoc引用是否可解析、是否适用于被继承的契约生成绑定的直接///注释编辑是否被utils/SkiaSharpGenerator的再生成保留且没有手改声明或 interop 代码报告格式逐行机器可读输出发现行Finding每个发现输出一行格式固定SEVERITY | class | source file:line | type.member | what the comment says; source evidence path:line; required correction字段含义严重级别 | 类别 | 源码文件与行号 | 类型.成员 | 注释原文源码证据路径:行号所需修正。只报告高置信度、带源码引用的事实性发现无法验证的事实应标记为UNVERIFIED而非缺陷。追踪行Trace对每个被审源码文件输出一行追踪记录TRACE | source file | declarations:n | implementation-read:yes/no | issues:n字段含义源码文件 | 声明数 | 是否读过实现 | 问题数。结论评估报告末尾给出审查的文件/声明数量、按严重级别统计的数量以及三档评估结论之一——Ready for release可发布、Needs fixes需要修复或Major issues存在重大问题。一个补充原则不要把仅存在于实现程序集中的 XML 条目当作覆盖面缺口coverage gap——只有引用程序集旁边的 XML 才定义消费者可见的文档表面。仓库事实编译器 XML 会同时打包到lib/tfm与ref/tfm但只有ref/tfm下的 XML 是消费者可见的文档契约见 SKILL.md 与 validation.md。严重性分级速查来自 checklist.mdCRITICAL — 必须修复XML 格式错误、、未转义标签不匹配/未闭合导致编译器 XML 无效或产生文档警告捏造的类型、成员、重载、参数名、异常类型或cref无法解析的inheritdoc无法编译的示例示例中出现错误级废弃 API含遗留SKPaint文本成员、缺少SKFont的SKCanvas.DrawText重载错误的所有权、释放、线程、安全、原生数据布局或标准指导如释放SKSurface.Canvas、把SKColor写成 BGRA、把 SMPTE RP 431-2 写成 432-2、把 ST 428-1 传递函数说成线性面向公众的拼写错误、重复词、冒犯性术语、暴露的凭据/个人数据/内部 URL。IMPORTANT — 应当修复新增/变更的消费者可见公共声明缺少准确summary或必要的参数/类型参数/返回值/值/异常信息措辞与源码校验、可空性、默认值、工厂失败行为、访问器或所有权矛盾如把零初始化结构体属性默认值写成兄弟典型常量构造函数未用 Initializes a new instance of the … class/struct可写属性写成 Gets布尔参数/返回值措辞颠倒 true to 与 true if关键字用纯文本/反引号而非see langword… /可空参数写成default而非null转义、cref、paramref、typeparamref、异常关联或参数/泛型参数名错误示例非自包含、解引用可空工厂结果、使用警告级废弃 API、释放父拥有对象直接编辑了生成绑定的声明、interop 或实现或直接编辑///注释后未经utils/SkiaSharpGenerator再生成回环验证。MINOR — 顺手改进正确但可更清晰/更具体的摘要不改变事实含义平行成员间不一致但均合法的措辞缺少有用但非必需的remarks、example、paramref或交叉引用与源码注释约定不一致的空白、句点或大小写。小结SkiaSharp 的 API 文档审查是一条先读源码、再读注释、后写报告的流水线范围划到公共声明逐元素核对 XML 结构把示例当代码编译验证把所有权/默认值/标准/字节序等事实全部回源取证最后按SEVERITY | …与TRACE | …的固定格式输出机器可读结果。这套流程既保证注释在编译为 XML 并被引用程序集消费后依然真实准确也通过utils/SkiaSharpGenerator回环与 validation.md 的构建/包校验守住只改源码注释、不动生成物的仓库边界。结合 adding.md编写侧与 patterns.md语法侧即可对 SkiaSharp / HarfBuzzSharp 的全部公共 API 完成高质量、可复现的文档审阅。赞分享图形学图像处理跨平台【免费下载链接】SkiaSharpSkiaSharp is a cross-platform 2D graphics API for .NET platforms based on Googles Skia Graphics Library. It provides a comprehensive 2D API that can be used across mobile, server and desktop models to render images.项目地址https://gitcode.com/gh_mirrors/sk/SkiaSharp点击查看免费下载相关推荐hotel源码贡献指南Issue报告、Pull Request规范与代码审查流程hotel源码贡献指南Issue报告、Pull Request规范与代码审查流程 作为一款面向开发者的本地服务器管理工具hotel允许用户通过浏览器管理本地开发工具CLISkiaSharp API 文档编写规范C XML 注释模式与实战指南SkiaSharp API 文档编写规范C XML 注释模式与实战指南 本篇指南系统讲解 SkiaSharp 仓库中公共 API 的 C XML 文档注释图形学图像处理跨平台ZeroClaw Rust 代码审查风格指南面向 AI 审查者的安全优先审查规范ZeroClaw Rust 代码审查风格指南面向 AI 审查者的安全优先审查规范 ZeroClaw 是一个用 Rust 编写的安全敏感型 AI 个人助理基础设人工智能AI Agent交互助手工具调用MCP Clients本地部署Agent 工作流RAG上一篇如何通过palworld-save-tools实现高效游戏存档管理全攻略下一篇终极Firebase JavaScript SDK分析工具深入解析用户行为数据的完整指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
