DESCRIBE: XML ドキュメントコメントを追記。
@@ -25,12 +25,21 @@ | ||
25 | 25 | |
26 | 26 | namespace Sasa.QualityTools.DrFx.Explorer |
27 | 27 | { |
28 | + /// <summary> | |
29 | + /// DrFx Explorer のメイン画面を表します。 | |
30 | + /// </summary> | |
28 | 31 | public partial class MainWindow : Window |
29 | 32 | { |
33 | + /// <summary> | |
34 | + /// バージョン番号。 | |
35 | + /// </summary> | |
30 | 36 | private string version; |
31 | 37 | |
32 | 38 | |
33 | 39 | |
40 | + /// <summary> | |
41 | + /// バージョン番号。 | |
42 | + /// </summary> | |
34 | 43 | public string Version |
35 | 44 | { |
36 | 45 | get |
@@ -45,6 +54,9 @@ | ||
45 | 54 | |
46 | 55 | |
47 | 56 | |
57 | + /// <summary> | |
58 | + /// <see cref="Sasa.QualityTools.DrFx.Explorer.MainWindow"/> クラスの新しいインスタンスを初期化します。 | |
59 | + /// </summary> | |
48 | 60 | public MainWindow() |
49 | 61 | { |
50 | 62 | InitializeComponent(); |
@@ -52,6 +64,11 @@ | ||
52 | 64 | |
53 | 65 | |
54 | 66 | |
67 | + /// <summary> | |
68 | + /// FxCop レポート表示画面を開きます。 | |
69 | + /// </summary> | |
70 | + /// <param name="sender">イベント送信元オブジェクト。</param> | |
71 | + /// <param name="e">イベントデータ。</param> | |
55 | 72 | private void OpenReport(object sender, ExecutedRoutedEventArgs e) |
56 | 73 | { |
57 | 74 | string file = DialogHelper.SelectFxCopReportFile(); |
@@ -23,8 +23,15 @@ | ||
23 | 23 | |
24 | 24 | namespace Sasa.QualityTools.DrFx.Explorer |
25 | 25 | { |
26 | + /// <summary> | |
27 | + /// ダイアログ表示用のヘルパークラスです。 | |
28 | + /// </summary> | |
26 | 29 | internal static class DialogHelper |
27 | 30 | { |
31 | + /// <summary> | |
32 | + /// FxCop レポートファイル選択ダイアログを表示します。 | |
33 | + /// </summary> | |
34 | + /// <returns>FxCop レポートファイルのパス。選択がキャンセルされた場合は null。</returns> | |
28 | 35 | internal static string SelectFxCopReportFile() |
29 | 36 | { |
30 | 37 | using (OpenFileDialog dialog = new OpenFileDialog()) |
@@ -29,14 +29,26 @@ | ||
29 | 29 | |
30 | 30 | namespace Sasa.QualityTools.DrFx.Explorer |
31 | 31 | { |
32 | + /// <summary> | |
33 | + /// FxCop のルール違反の詳細を表示するためのウェジットを表すクラスです。 | |
34 | + /// </summary> | |
32 | 35 | public partial class FxCopIssueDetailWidget : UserControl |
33 | 36 | { |
34 | - public static DependencyProperty FxCopIssueRelationshipProperty = DependencyProperty.Register("FxCopIssueRelationship", typeof(FxCopIssueRelationship), typeof(FxCopIssueDetailWidget), new PropertyMetadata(OnFxCopIssueDetailWidgetChanged)); | |
37 | + /// <summary> | |
38 | + /// ルール違反情報のリレーションシップを表す依存プロパティ。 | |
39 | + /// </summary> | |
40 | + public static DependencyProperty FxCopIssueRelationshipProperty = DependencyProperty.Register("FxCopIssueRelationship", typeof(FxCopIssueRelationship), typeof(FxCopIssueDetailWidget), new PropertyMetadata(OnFxCopIssueRelationshipChanged)); | |
35 | 41 | |
42 | + /// <summary> | |
43 | + /// ルール違反したソースコード行前後のソースコード行のコレクション。 | |
44 | + /// </summary> | |
36 | 45 | private ObservableCollection<SourceCodeLine> lines = new ObservableCollection<SourceCodeLine>(); |
37 | 46 | |
38 | 47 | |
39 | 48 | |
49 | + /// <summary> | |
50 | + /// ルール違反情報のリレーションシップ。 | |
51 | + /// </summary> | |
40 | 52 | public FxCopIssueRelationship FxCopIssueRelationship |
41 | 53 | { |
42 | 54 | get |
@@ -50,6 +62,9 @@ | ||
50 | 62 | } |
51 | 63 | } |
52 | 64 | |
65 | + /// <summary> | |
66 | + /// ルール違反したソースコード行前後のソースコード行のコレクション。 | |
67 | + /// </summary> | |
53 | 68 | public ObservableCollection<SourceCodeLine> Lines |
54 | 69 | { |
55 | 70 | get |
@@ -60,6 +75,9 @@ | ||
60 | 75 | |
61 | 76 | |
62 | 77 | |
78 | + /// <summary> | |
79 | + /// <see cref="Sasa.QualityTools.DrFx.Explorer.FxCopIssueDetailWidget"/> クラスの新しいインスタンスを初期化します。 | |
80 | + /// </summary> | |
63 | 81 | public FxCopIssueDetailWidget() |
64 | 82 | { |
65 | 83 | InitializeComponent(); |
@@ -67,6 +85,13 @@ | ||
67 | 85 | |
68 | 86 | |
69 | 87 | |
88 | + /// <summary> | |
89 | + /// <paramref name="filePath"/> で指定されたファイルから、<paramref name="lineNumber"/> で指定された | |
90 | + /// 付近のソースコード行を取得します。 | |
91 | + /// </summary> | |
92 | + /// <param name="filePath">ファイルパス。</param> | |
93 | + /// <param name="lineNumber">行番号。</param> | |
94 | + /// <returns>指定された行番号前後のソースコード行のリスト。</returns> | |
70 | 95 | internal static List<SourceCodeLine> GetViolationCodeLines(string filePath, int lineNumber) |
71 | 96 | { |
72 | 97 | if (String.IsNullOrEmpty(filePath) || File.Exists(filePath) == false || lineNumber <= 0) |
@@ -114,7 +139,12 @@ | ||
114 | 139 | return lines; |
115 | 140 | } |
116 | 141 | |
117 | - private static void OnFxCopIssueDetailWidgetChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) | |
142 | + /// <summary> | |
143 | + /// ルール違反リレーションシップの値が変わった場合に、ルール違反箇所付近のソースコードを取得しなおします。 | |
144 | + /// </summary> | |
145 | + /// <param name="sender">イベント送信元オブジェクト。</param> | |
146 | + /// <param name="e">イベントデータ。</param> | |
147 | + private static void OnFxCopIssueRelationshipChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) | |
118 | 148 | { |
119 | 149 | FxCopIssueDetailWidget widget = (FxCopIssueDetailWidget)sender; |
120 | 150 | FxCopIssueRelationship relationship = e.NewValue as FxCopIssueRelationship; |
@@ -27,16 +27,31 @@ | ||
27 | 27 | |
28 | 28 | namespace Sasa.QualityTools.DrFx.Explorer |
29 | 29 | { |
30 | + /// <summary> | |
31 | + /// DrFx Explorer のレポート表示画面を表します。 | |
32 | + /// </summary> | |
30 | 33 | public partial class FxCopReportWindow : Window |
31 | 34 | { |
35 | + /// <summary> | |
36 | + /// 読み込んだ FxCop レポートを表す依存プロパティ。 | |
37 | + /// </summary> | |
32 | 38 | public static readonly DependencyProperty FxCopReportProperty = DependencyProperty.Register("FxCopReport", typeof(FxCopReport), typeof(FxCopReportWindow)); |
33 | 39 | |
40 | + /// <summary> | |
41 | + /// ルール違反情報と、ルール違反対象や違反したルールの詳細情報の全リレーションのリスト。 | |
42 | + /// </summary> | |
34 | 43 | private List<FxCopIssueRelationship> relationships = new List<FxCopIssueRelationship>(); |
35 | 44 | |
45 | + /// <summary> | |
46 | + /// 画面上で現在選択中の違反対象についての、ルール違反情報と、ルール違反対象や違反したルールの詳細情報のリレーションのリスト。 | |
47 | + /// </summary> | |
36 | 48 | private ObservableCollection<FxCopIssueRelationship> currentRelationships = new ObservableCollection<FxCopIssueRelationship>(); |
37 | 49 | |
38 | 50 | |
39 | 51 | |
52 | + /// <summary> | |
53 | + /// 読み込んだ FxCop レポート。 | |
54 | + /// </summary> | |
40 | 55 | public FxCopReport FxCopReport |
41 | 56 | { |
42 | 57 | get |
@@ -49,6 +64,9 @@ | ||
49 | 64 | } |
50 | 65 | } |
51 | 66 | |
67 | + /// <summary> | |
68 | + /// 画面上で現在選択中の違反対象についての、ルール違反情報と、ルール違反対象や違反したルールの詳細情報のリレーションのリスト。 | |
69 | + /// </summary> | |
52 | 70 | public ObservableCollection<FxCopIssueRelationship> CurrentRelationships |
53 | 71 | { |
54 | 72 | get |
@@ -59,6 +77,9 @@ | ||
59 | 77 | |
60 | 78 | |
61 | 79 | |
80 | + /// <summary> | |
81 | + /// <see cref="Sasa.QualityTools.DrFx.Explorer.FxCopReportWindow"/> クラスの新しいインスタンスを初期化します。 | |
82 | + /// </summary> | |
62 | 83 | public FxCopReportWindow() |
63 | 84 | { |
64 | 85 | InitializeComponent(); |
@@ -66,6 +87,10 @@ | ||
66 | 87 | |
67 | 88 | |
68 | 89 | |
90 | + /// <summary> | |
91 | + /// 画面表示時に、画面情報を初期化します。 | |
92 | + /// </summary> | |
93 | + /// <param name="e">イベントデータ。</param> | |
69 | 94 | protected override void OnContentRendered(EventArgs e) |
70 | 95 | { |
71 | 96 | base.OnContentRendered(e); |
@@ -79,6 +104,10 @@ | ||
79 | 104 | this.relationships.AddRange(CreateRelationships(FxCopReport)); |
80 | 105 | } |
81 | 106 | |
107 | + /// <summary> | |
108 | + /// ルール違反情報と、ルール違反対象や違反したルールの詳細情報のリレーションのコレクションを作成します。。 | |
109 | + /// </summary> | |
110 | + /// <param name="report">リレーションコレクションの作成に使用する、FxCop レポートの情報。</param> | |
82 | 111 | internal static IEnumerable<FxCopIssueRelationship> CreateRelationships(FxCopReport report) |
83 | 112 | { |
84 | 113 | List<FxCopIssueRelationship> relationships = new List<FxCopIssueRelationship>(); |
@@ -106,6 +135,11 @@ | ||
106 | 135 | return relationships; |
107 | 136 | } |
108 | 137 | |
138 | + /// <summary> | |
139 | + /// 指定されたアセンブリに関するルール違反情報のリレーションシップコレクションを作成します。 | |
140 | + /// </summary> | |
141 | + /// <param name="assembly">FxCop ルールに違反した (もしくはルール違反した型などを含む) アセンブリ。</param> | |
142 | + /// <returns>ルール違反情報のリレーションシップコレクション。</returns> | |
109 | 143 | internal static IEnumerable<FxCopIssueRelationship> CreateRelationships(AssemblyWarning assembly) |
110 | 144 | { |
111 | 145 | foreach (FxCopIssue issue in assembly.Issues) |
@@ -122,6 +156,11 @@ | ||
122 | 156 | } |
123 | 157 | } |
124 | 158 | |
159 | + /// <summary> | |
160 | + /// 指定された名前空間に関するルール違反情報のリレーションシップコレクションを作成します。 | |
161 | + /// </summary> | |
162 | + /// <param name="nameSpace">FxCop ルールに違反した (もしくはルール違反した型などを含む) 名前空間。</param> | |
163 | + /// <returns>ルール違反情報のリレーションシップコレクション。</returns> | |
125 | 164 | internal static IEnumerable<FxCopIssueRelationship> CreateRelationships(NamespaceWarning nameSpace) |
126 | 165 | { |
127 | 166 | foreach (FxCopIssue issue in nameSpace.Issues) |
@@ -138,6 +177,11 @@ | ||
138 | 177 | } |
139 | 178 | } |
140 | 179 | |
180 | + /// <summary> | |
181 | + /// 指定された型に関するルール違反情報のリレーションシップコレクションを作成します。 | |
182 | + /// </summary> | |
183 | + /// <param name="type">FxCop ルールに違反した (もしくはルール違反したメンバーを含む) 型。</param> | |
184 | + /// <returns>ルール違反情報のリレーションシップコレクション。</returns> | |
141 | 185 | internal static IEnumerable<FxCopIssueRelationship> CreateRelationships(TypeWarning type) |
142 | 186 | { |
143 | 187 | foreach (FxCopIssue issue in type.Issues) |
@@ -154,6 +198,11 @@ | ||
154 | 198 | } |
155 | 199 | } |
156 | 200 | |
201 | + /// <summary> | |
202 | + /// 指定されたメンバーに関するルール違反情報のリレーションシップコレクションを作成します。 | |
203 | + /// </summary> | |
204 | + /// <param name="type">FxCop ルールに違反したメンバー。</param> | |
205 | + /// <returns>ルール違反情報のリレーションシップコレクション。</returns> | |
157 | 206 | internal static IEnumerable<FxCopIssueRelationship> CreateRelationships(MemberWarning member) |
158 | 207 | { |
159 | 208 | foreach (FxCopIssue issue in member.Issues) |
@@ -162,6 +211,11 @@ | ||
162 | 211 | } |
163 | 212 | } |
164 | 213 | |
214 | + /// <summary> | |
215 | + /// 画面上で選択された違反対象に対応する違反情報コレクションを作成します。 | |
216 | + /// </summary> | |
217 | + /// <param name="sender">イベント送信元オブジェクト。</param> | |
218 | + /// <param name="e">イベントデータ。</param> | |
165 | 219 | private void ShowIssues(object sender, RoutedEventArgs e) |
166 | 220 | { |
167 | 221 | TreeViewItem item = (TreeViewItem)sender; |
@@ -25,18 +25,36 @@ | ||
25 | 25 | |
26 | 26 | namespace Sasa.QualityTools.DrFx.Explorer.Report |
27 | 27 | { |
28 | + /// <summary> | |
29 | + /// FxCop レポートを表すクラスです。 | |
30 | + /// </summary> | |
28 | 31 | public class FxCopReport |
29 | 32 | { |
33 | + /// <summary> | |
34 | + /// FxCop ルールに違反したアセンブリの情報のリスト。 | |
35 | + /// </summary> | |
30 | 36 | private List<AssemblyWarning> assemblies; |
31 | 37 | |
38 | + /// <summary> | |
39 | + /// FxCop ルールに違反した名前空間の情報のリスト。 | |
40 | + /// </summary> | |
32 | 41 | private List<NamespaceWarning> namespaces; |
33 | 42 | |
43 | + /// <summary> | |
44 | + /// FxCop レポートの中に埋め込まれていた (つまり、違反が検出された) ルール情報。 | |
45 | + /// </summary> | |
34 | 46 | private Dictionary<string, FxCopRule> rules; |
35 | 47 | |
36 | 48 | |
37 | 49 | |
50 | + /// <summary> | |
51 | + /// レポートファイルのパス。 | |
52 | + /// </summary> | |
38 | 53 | public string ReportFile { get; private set; } |
39 | 54 | |
55 | + /// <summary> | |
56 | + /// FxCop ルールに違反したアセンブリの情報のリスト。 | |
57 | + /// </summary> | |
40 | 58 | public IEnumerable<AssemblyWarning> Assemblies |
41 | 59 | { |
42 | 60 | get |
@@ -45,6 +63,9 @@ | ||
45 | 63 | } |
46 | 64 | } |
47 | 65 | |
66 | + /// <summary> | |
67 | + /// FxCop ルールに違反した名前空間の情報のリスト。 | |
68 | + /// </summary> | |
48 | 69 | public IEnumerable<NamespaceWarning> Namespaces |
49 | 70 | { |
50 | 71 | get |
@@ -53,6 +74,9 @@ | ||
53 | 74 | } |
54 | 75 | } |
55 | 76 | |
77 | + /// <summary> | |
78 | + /// FxCop レポートの中に埋め込まれていた (つまり、違反が検出された) ルール情報。 | |
79 | + /// </summary> | |
56 | 80 | public IDictionary<string, FxCopRule> Rules |
57 | 81 | { |
58 | 82 | get |
@@ -63,6 +87,9 @@ | ||
63 | 87 | |
64 | 88 | |
65 | 89 | |
90 | + /// <summary> | |
91 | + /// <see cref="Sasa.QualityTools.DrFx.Explorer.Report.FxCopReport"/> クラスの新しいインスタンスを初期化します。 | |
92 | + /// </summary> | |
66 | 93 | private FxCopReport() |
67 | 94 | { |
68 | 95 | this.assemblies = new List<AssemblyWarning>(); |
@@ -73,10 +100,10 @@ | ||
73 | 100 | |
74 | 101 | |
75 | 102 | /// <summary> |
76 | - /// 指定された FxCop レポートを解析し、オブジェクト化します。 | |
103 | + /// 指定された FxCop レポートを解析し、インスタンス化します。 | |
77 | 104 | /// </summary> |
78 | 105 | /// <param name="file">FxCop レポートファイルのパス。</param> |
79 | - /// <returns>指定された FxCop レポートを表すオブジェクト。</returns> | |
106 | + /// <returns>指定された FxCop レポートを表すインスタンス。</returns> | |
80 | 107 | /// <exception cref="System.ArgumentException"><paramref name="file"/> として null や空文字列、ファイルシステム上に存在しないパスが指定された場合に発生します。</exception> |
81 | 108 | public static FxCopReport Load(string file) |
82 | 109 | { |
@@ -106,6 +133,12 @@ | ||
106 | 133 | return report; |
107 | 134 | } |
108 | 135 | |
136 | + /// <summary> | |
137 | + /// FxCop レポートの Targets ノードを基に、<see cref="Sasa.QualityTools.DrFx.Explorer.Report.AssemblyWarning"/> オブジェクトの | |
138 | + /// コレクションを作成します。 | |
139 | + /// </summary> | |
140 | + /// <param name="assembliesNode">FxCop レポートの Targets ノード。</param> | |
141 | + /// <returns>FxCop レポートの Targets ノードを基に作成した <see cref="Sasa.QualityTools.DrFx.Explorer.Report.AssemblyWarning"/> オブジェクトのコレクション。</returns> | |
109 | 142 | internal static List<AssemblyWarning> CreateAssemblyWarnings(XmlNode assembliesNode) |
110 | 143 | { |
111 | 144 | if (assembliesNode == null) |
@@ -139,6 +172,12 @@ | ||
139 | 172 | return assemblies; |
140 | 173 | } |
141 | 174 | |
175 | + /// <summary> | |
176 | + /// FxCop レポートの Namespaces ノードを基に、<see cref="Sasa.QualityTools.DrFx.Explorer.Report.NamespaceWarning"/> オブジェクトの | |
177 | + /// コレクションを作成します。 | |
178 | + /// </summary> | |
179 | + /// <param name="namespacesNode">FxCop レポートの Namespaces ノード。</param> | |
180 | + /// <returns>FxCop レポートの Namespaces ノードを基に作成した <see cref="Sasa.QualityTools.DrFx.Explorer.Report.NamespaceWarning"/> オブジェクトのコレクション。</returns> | |
142 | 181 | internal static List<NamespaceWarning> CreateNamespaceWarnings(XmlNode namespacesNode) |
143 | 182 | { |
144 | 183 | if (namespacesNode == null) |
@@ -267,6 +306,12 @@ | ||
267 | 306 | return issues; |
268 | 307 | } |
269 | 308 | |
309 | + /// <summary> | |
310 | + /// FxCop レポートの Rules ノードを基に、<see cref="Sasa.QualityTools.DrFx.Explorer.Report.FxCopRule"/> オブジェクトの | |
311 | + /// コレクションを作成します。 | |
312 | + /// </summary> | |
313 | + /// <param name="rulesNode">FxCop レポートの Rules ノード。</param> | |
314 | + /// <returns>FxCop レポートの Rules ノードを基に作成した <see cref="Sasa.QualityTools.DrFx.Explorer.Report.FxCopRule"/> オブジェクトのコレクション。</returns> | |
270 | 315 | internal static List<FxCopRule> CreateRules(XmlNode rulesNode) |
271 | 316 | { |
272 | 317 | if (rulesNode == null) |
@@ -27,10 +27,29 @@ | ||
27 | 27 | /// </summary> |
28 | 28 | public enum WarningTarget |
29 | 29 | { |
30 | + /// <summary> | |
31 | + /// 対象が不明であることを表します。 | |
32 | + /// </summary> | |
30 | 33 | Unknown = 0, |
34 | + | |
35 | + /// <summary> | |
36 | + /// アセンブリが対象であることを表します。 | |
37 | + /// </summary> | |
31 | 38 | Assembly, |
39 | + | |
40 | + /// <summary> | |
41 | + /// 名前空間が対象であることを表します。 | |
42 | + /// </summary> | |
32 | 43 | Namespace, |
44 | + | |
45 | + /// <summary> | |
46 | + /// 型が対象であることを表します。 | |
47 | + /// </summary> | |
33 | 48 | Type, |
49 | + | |
50 | + /// <summary> | |
51 | + /// メンバーが対象であることを表します。 | |
52 | + /// </summary> | |
34 | 53 | Member |
35 | 54 | } |
36 | 55 | } |
@@ -25,6 +25,9 @@ | ||
25 | 25 | { |
26 | 26 | public class MemberWarning |
27 | 27 | { |
28 | + /// <summary> | |
29 | + /// アセンブリに対する違反メッセージのコレクション。 | |
30 | + /// </summary> | |
28 | 31 | private Collection<FxCopIssue> issues = new Collection<FxCopIssue>(); |
29 | 32 | |
30 | 33 |
@@ -33,6 +36,9 @@ | ||
33 | 36 | |
34 | 37 | public string Kind { get; internal set; } |
35 | 38 | |
39 | + /// <summary> | |
40 | + /// アセンブリに対する違反メッセージのコレクション。 | |
41 | + /// </summary> | |
36 | 42 | public Collection<FxCopIssue> Issues |
37 | 43 | { |
38 | 44 | get |
@@ -28,6 +28,9 @@ | ||
28 | 28 | { |
29 | 29 | private Collection<TypeWarning> types = new Collection<TypeWarning>(); |
30 | 30 | |
31 | + /// <summary> | |
32 | + /// アセンブリに対する違反メッセージのコレクション。 | |
33 | + /// </summary> | |
31 | 34 | private Collection<FxCopIssue> issues = new Collection<FxCopIssue>(); |
32 | 35 | |
33 | 36 |
@@ -42,6 +45,9 @@ | ||
42 | 45 | } |
43 | 46 | } |
44 | 47 | |
48 | + /// <summary> | |
49 | + /// アセンブリに対する違反メッセージのコレクション。 | |
50 | + /// </summary> | |
45 | 51 | public Collection<FxCopIssue> Issues |
46 | 52 | { |
47 | 53 | get |
@@ -22,12 +22,24 @@ | ||
22 | 22 | |
23 | 23 | namespace Sasa.QualityTools.DrFx.Explorer.Report |
24 | 24 | { |
25 | + /// <summary> | |
26 | + /// ルール違反したソースコード行を表すクラスです。 | |
27 | + /// </summary> | |
25 | 28 | public class SourceCodeLine |
26 | 29 | { |
30 | + /// <summary> | |
31 | + /// ソースコードの行番号。 | |
32 | + /// </summary> | |
27 | 33 | public int LineNumber { get; internal set; } |
28 | 34 | |
35 | + /// <summary> | |
36 | + /// ソースコード行。 | |
37 | + /// </summary> | |
29 | 38 | public string Text { get; internal set; } |
30 | 39 | |
40 | + /// <summary> | |
41 | + /// ルール違反していると直接レポートされた行かどうか。 | |
42 | + /// </summary> | |
31 | 43 | public bool IsViolationLine { get; internal set; } |
32 | 44 | } |
33 | 45 | } |
@@ -23,18 +23,36 @@ | ||
23 | 23 | |
24 | 24 | namespace Sasa.QualityTools.DrFx.Explorer.Report |
25 | 25 | { |
26 | + /// <summary> | |
27 | + /// FxCop ルールに違反したアセンブリの情報を表すクラスです。 | |
28 | + /// </summary> | |
26 | 29 | public class AssemblyWarning |
27 | 30 | { |
31 | + /// <summary> | |
32 | + /// FxCop ルールに違反した名前空間の情報のコレクション。 | |
33 | + /// </summary> | |
28 | 34 | private Collection<NamespaceWarning> namespaces = new Collection<NamespaceWarning>(); |
29 | 35 | |
36 | + /// <summary> | |
37 | + /// アセンブリに対する違反メッセージのコレクション。 | |
38 | + /// </summary> | |
30 | 39 | private Collection<FxCopIssue> issues = new Collection<FxCopIssue>(); |
31 | 40 | |
32 | 41 | |
33 | 42 | |
43 | + /// <summary> | |
44 | + /// アセンブリのフルパス。 | |
45 | + /// </summary> | |
34 | 46 | public string FileName { get; internal set; } |
35 | 47 | |
48 | + /// <summary> | |
49 | + /// アセンブリのファイル名 (ディレクトリ情報なし)。 | |
50 | + /// </summary> | |
36 | 51 | public string BaseName { get; internal set; } |
37 | 52 | |
53 | + /// <summary> | |
54 | + /// FxCop ルールに違反した名前空間の情報のコレクション。 | |
55 | + /// </summary> | |
38 | 56 | public Collection<NamespaceWarning> Namespaces |
39 | 57 | { |
40 | 58 | get |
@@ -43,6 +61,9 @@ | ||
43 | 61 | } |
44 | 62 | } |
45 | 63 | |
64 | + /// <summary> | |
65 | + /// アセンブリに対する違反メッセージのコレクション。 | |
66 | + /// </summary> | |
46 | 67 | public Collection<FxCopIssue> Issues |
47 | 68 | { |
48 | 69 | get |
@@ -22,14 +22,29 @@ | ||
22 | 22 | |
23 | 23 | namespace Sasa.QualityTools.DrFx.Explorer.Report |
24 | 24 | { |
25 | + /// <summary> | |
26 | + /// FxCop のルールを表すクラスです。 | |
27 | + /// </summary> | |
25 | 28 | public class FxCopRule |
26 | 29 | { |
30 | + /// <summary> | |
31 | + /// チェック ID。 | |
32 | + /// </summary> | |
27 | 33 | public string CheckId { get; internal set; } |
28 | 34 | |
35 | + /// <summary> | |
36 | + /// ルールのカテゴリ。 | |
37 | + /// </summary> | |
29 | 38 | public string Category { get; internal set; } |
30 | 39 | |
40 | + /// <summary> | |
41 | + /// ルール名。 | |
42 | + /// </summary> | |
31 | 43 | public string Name { get; internal set; } |
32 | 44 | |
45 | + /// <summary> | |
46 | + /// ルールの詳細。 | |
47 | + /// </summary> | |
33 | 48 | public string Description { get; internal set; } |
34 | 49 | } |
35 | 50 | } |
@@ -27,6 +27,9 @@ | ||
27 | 27 | { |
28 | 28 | private Collection<MemberWarning> members = new Collection<MemberWarning>(); |
29 | 29 | |
30 | + /// <summary> | |
31 | + /// アセンブリに対する違反メッセージのコレクション。 | |
32 | + /// </summary> | |
30 | 33 | private Collection<FxCopIssue> issues = new Collection<FxCopIssue>(); |
31 | 34 | |
32 | 35 |
@@ -43,6 +46,9 @@ | ||
43 | 46 | } |
44 | 47 | } |
45 | 48 | |
49 | + /// <summary> | |
50 | + /// アセンブリに対する違反メッセージのコレクション。 | |
51 | + /// </summary> | |
46 | 52 | public Collection<FxCopIssue> Issues |
47 | 53 | { |
48 | 54 | get |
@@ -22,22 +22,49 @@ | ||
22 | 22 | |
23 | 23 | namespace Sasa.QualityTools.DrFx.Explorer.Report |
24 | 24 | { |
25 | + /// <summary> | |
26 | + /// FxCop ルールへの違反に関する情報を保持するクラスです。 | |
27 | + /// </summary> | |
25 | 28 | public class FxCopIssue |
26 | 29 | { |
30 | + /// <summary> | |
31 | + /// 違反したルールを定義しているルールクラス名。 | |
32 | + /// </summary> | |
27 | 33 | public string TypeName { get; internal set; } |
28 | 34 | |
35 | + /// <summary> | |
36 | + /// 違反したルールのカテゴリ。 | |
37 | + /// </summary> | |
29 | 38 | public string Category { get; internal set; } |
30 | 39 | |
40 | + /// <summary> | |
41 | + /// 違反したルールのチェック ID。 | |
42 | + /// </summary> | |
31 | 43 | public string CheckId { get; internal set; } |
32 | 44 | |
45 | + /// <summary> | |
46 | + /// 違反情報のステータス。 | |
47 | + /// </summary> | |
33 | 48 | public string Status { get; internal set; } |
34 | 49 | |
50 | + /// <summary> | |
51 | + /// 違反情報のレベル。 | |
52 | + /// </summary> | |
35 | 53 | public string Level { get; internal set; } |
36 | 54 | |
55 | + /// <summary> | |
56 | + /// ルール違反したソースコードのパス。 | |
57 | + /// </summary> | |
37 | 58 | public string FilePath { get; internal set; } |
38 | 59 | |
60 | + /// <summary> | |
61 | + /// ルール違反したソースコードの行番号。 | |
62 | + /// </summary> | |
39 | 63 | public int? Line { get; internal set; } |
40 | 64 | |
65 | + /// <summary> | |
66 | + /// 違反メッセージ。 | |
67 | + /// </summary> | |
41 | 68 | public string Content { get; internal set; } |
42 | 69 | } |
43 | 70 | } |
@@ -22,20 +22,44 @@ | ||
22 | 22 | |
23 | 23 | namespace Sasa.QualityTools.DrFx.Explorer.Report |
24 | 24 | { |
25 | + /// <summary> | |
26 | + /// ルール違反情報と、ルール違反対象や違反したルールの詳細情報をリンクさせるためのクラスです。 | |
27 | + /// </summary> | |
25 | 28 | public class FxCopIssueRelationship |
26 | 29 | { |
30 | + /// <summary> | |
31 | + /// ルール違反情報。 | |
32 | + /// </summary> | |
33 | + public FxCopIssue Issue { get; set; } | |
34 | + | |
35 | + /// <summary> | |
36 | + /// ルール違反対象のアセンブリの情報。もしくはルール違反対象のメンバーが属しているのアセンブリの情報。 | |
37 | + /// </summary> | |
27 | 38 | public AssemblyWarning Assembly { get; set; } |
28 | 39 | |
40 | + /// <summary> | |
41 | + /// ルール違反対象の名前空間の情報。もしくはルール違反対象のメンバーが属しているの名前空間の情報。 | |
42 | + /// </summary> | |
29 | 43 | public NamespaceWarning Namespace { get; set; } |
30 | 44 | |
45 | + /// <summary> | |
46 | + /// ルール違反対象の型の情報。もしくはルール違反対象のメンバーが属しているの型の情報。 | |
47 | + /// </summary> | |
31 | 48 | public TypeWarning Type { get; set; } |
32 | 49 | |
50 | + /// <summary> | |
51 | + /// ルール違反対象のメンバーの情報。 | |
52 | + /// </summary> | |
33 | 53 | public MemberWarning Member { get; set; } |
34 | 54 | |
35 | - public FxCopIssue Issue { get; set; } | |
36 | - | |
55 | + /// <summary> | |
56 | + /// 違反したルール自体の情報。 | |
57 | + /// </summary> | |
37 | 58 | public FxCopRule Rule { get; set; } |
38 | 59 | |
60 | + /// <summary> | |
61 | + /// ルール違反対象。 | |
62 | + /// </summary> | |
39 | 63 | public WarningTarget Target { get; set; } |
40 | 64 | } |
41 | 65 | } |
@@ -23,6 +23,9 @@ | ||
23 | 23 | |
24 | 24 | namespace Sasa.QualityTools.DrFx.Explorer |
25 | 25 | { |
26 | + /// <summary> | |
27 | + /// アプリケーションの実行コンテキストを表すクラスです。 | |
28 | + /// </summary> | |
26 | 29 | public partial class ExecutionContext : Application |
27 | 30 | { |
28 | 31 | } |