使用TFS API,我如何找到在代码审查中所做的注释?

本文关键字:代码审查 注释 API TFS 何找 使用 | 更新日期: 2023-09-27 18:09:45

我正试图找出一种方法来查找有关TFS2012中代码审查请求/响应项的详细信息。

我可以通过以下方式查询所有代码审查请求/响应项:

const string TfsUri = "http://mytfsserver:8080/tfs/Default ProjectCollection";
var tfs = new TfsTeamProjectCollection(new Uri(TfsUri));
var store = tfs.GetService<WorkItemStore>();
var versionStore = tfs.GetService<Microsoft.TeamFoundation.VersionControl.Client.VersionControlServer>();
var queryText = "SELECT [System.Id], 
                 FROM WorkItems 
                 WHERE [System.WorkItemType] = 'Code Review Request' 
                 or [System.WorkItemType] = 'Code Review Response'";
var query = new Query(store, queryText);
var result = query.RunQuery().OfType<WorkItem>();

这给出了WorkItem类型的列表。当我循环result.FirstOrDefault().Fields属性时,它确实给了我一些关于ShelveSet的有用信息,这些信息与代码审查相关,即"关联上下文"。使用这些信息,我可以查询ShelveSet:

var versionStore = tfs.GetService<VersionControlServer>();
var shelveset = versionStore.QueryShelvesets("someCodeReviewId_xxxx","someUserName");

这给了我一个ShelveSet项目,但这就是我卡住的地方。

我已经研究了Microsoft.TeamFoundation.CodeReview.ComponentsMicrosoft.TeamFoundation.CodeReview.Controls库提供的Microsoft.TeamFoundation.CodeReview命名空间,但这也没有进一步帮助我。

我的问题是:如何通过TFS API在代码审查期间(包括通用注释和文件注释)找到ShelveSet上的实际注释?

使用TFS API,我如何找到在代码审查中所做的注释?

我们有一个新的需求,从TFS中提取代码审查注释,下面是我们实现的一个简短示例。必须通过另一种方法查询workItemId。你甚至可以在Visual Studio或通过UI中的TFS查询来查找它。这只是可用的和我们正在使用的一小部分。在浏览了MSDN后,我发现这个链接很有帮助。

 public List<CodeReviewComment> GetCodeReviewComments(int workItemId)
 {
        List<CodeReviewComment> comments = new List<CodeReviewComment>();
        Uri uri = new Uri(URL_TO_TFS_COLLECTION);
        TeamFoundationDiscussionService service = new TeamFoundationDiscussionService();
        service.Initialize(new Microsoft.TeamFoundation.Client.TfsTeamProjectCollection(uri));
        IDiscussionManager discussionManager = service.CreateDiscussionManager();
        IAsyncResult result = discussionManager.BeginQueryByCodeReviewRequest(workItemId, QueryStoreOptions.ServerAndLocal, new AsyncCallback(CallCompletedCallback), null);
        var output = discussionManager.EndQueryByCodeReviewRequest(result);
        foreach (DiscussionThread thread in output)
        {
            if (thread.RootComment != null)
            {
                CodeReviewComment comment = new CodeReviewComment();
                comment.Author = thread.RootComment.Author.DisplayName;
                comment.Comment = thread.RootComment.Content;
                comment.PublishDate = thread.RootComment.PublishedDate.ToShortDateString();
                comment.ItemName = thread.ItemPath;
                comments.Add(comment);
            }
        }
        return comments;
    }
    static void CallCompletedCallback(IAsyncResult result)
    {
        // Handle error conditions here
    }
    public class CodeReviewComment
    {
        public string Author { get; set; }
        public string Comment { get; set; }
        public string PublishDate { get; set; }
        public string ItemName { get; set; }
    }

我没有代码示例,但是根据这个讨论,您应该能够使用Microsoft.TeamFoundation.Discussion.Client名称空间中的功能获得代码审查注释。

具体来说,注释可以通过DiscussionThread类访问。您应该能够使用IDiscussionManager查询讨论。