我常用的插件注释模板(Dynamics 365)

归档62

Dynamics 36529 Firefly主题文章示例9 杂物间9 在路上8 Csharp2 MS Office2 Cooking1 Git和Github1 理解计算机1

442 字

2 分钟

我常用的插件注释模板(Dynamics 365)

2022-02-16

Dynamics 365

Dynamics 365 Develop

Dynamics 365 Plug-in

浏览量加载中...

在 Dynamics 365 项目中，插件往往是业务逻辑最集中、最容易踩坑的地方。当项目周期拉长、人员更替或多人并行开发时，如果缺少清晰、统一的插件注释，维护成本会迅速放大

下面整理的是我在多个 Dynamics 365 项目中反复使用的插件注释模板，目标只有一个：让后来的人在不翻代码、不查注册记录的情况下，也能快速理解这个插件在 “什么时候、对什么、做了什么”

插件注释模板示例#

1
/// <summary>
2
/// <list type="bullet">
3
/// <item>模块：售前(示例)</item>
4
/// <item>功能</item>
5
/// <list type="number">
6
/// <item>功能描述 xxxx xxxx xxxx</item>
7
/// <item>功能描述 xxxx xxxx xxxx</item>
8
/// </list>
9
/// <item>Primary Entity: Lead</item>
10
/// <item>Message: Update</item>
11
/// <item>Update Attributes: qualifyingopportunityid, statecode</item>
12
/// <item>State: PostOperation</item>
13
/// <item>Mode: Synchronous</item>
14
/// </list>
15
/// </summary>

说明#

模块 + 功能描述：从业务角度快速定位用途
Primary Entity / Message / Stage / Mode：与插件注册信息一一对应
Update Attributes：明确触发条件，避免“为什么会执行”的疑问

这套结构在代码审查、问题排查、插件迁移时都非常实用

Message/State/Mode 常见取值#

Message	1	Create
	2	Update
	3	Delete
	4	Associate
	5	Disassociate
	6	SetStateDynamicEntity
	7	RetrieveMultiple
	8	Retrieve
	9	QualifyLead
	10	Assign
State 执行阶段	1	Pre-validation
	2	Pre-operation
	3	Post-operation
Mode 执行模式	1	Synchronous
Mode 执行模式	2	Asynchronous

完整插件示例#

1
using Microsoft.Xrm.Sdk;
2
using System;
3
namespace Blog.D365.Plugins.Account
4
{
5
    // [!code ++:15]
6
    /// <summary>
7
    /// <list type="bullet">
8
    /// <item>模块：售前(示例)</item>
9
    /// <item>功能</item>
10
    /// <list type="number">
11
    /// <item>功能描述 xxxx xxxx xxxx</item>
12
    /// <item>功能描述 xxxx xxxx xxxx</item>
13
    /// </list>
14
    /// <item>Primary Entity: Lead</item>
15
    /// <item>Message: Update</item>
16
    /// <item>Update Attributes: qualifyingopportunityid, statecode</item>
17
    /// <item>State: PostOperation</item>
18
    /// <item>Mode: Synchronous</item>
19
    /// </list>
20
    /// </summary>
21
    public class AccountPostUpdate : IPlugin
22
    {
23
        public void Execute(IServiceProvider serviceProvider)
24
        {
25
            // 此处代码省略
26
        }
27
    }
28
}