NDepend.API Documentation
CommentsWereChanged Method (ICompareContext)
NDepend.CodeModel Namespace > ICompareContext Interface : CommentsWereChanged Method
The ICodeContainer object. A ICodeContainer object can be a IAssembly, INamespace, IType or IMethod object.
Returns true if comments of this codeContainer object, have been modified.
Syntax
bool CommentsWereChanged( 
   ICodeContainer codeContainer
)

Parameters

codeContainer
The ICodeContainer object. A ICodeContainer object can be a IAssembly, INamespace, IType or IMethod object.
Exceptions
ExceptionDescription
codeContainer is not NewerCodeBase nor OlderCodeBase not a code element that belong to any of these code base.
Remarks
So far, comments change is detected only when ICodeContainer.NbLinesOfComment has been changed.
This method has a constant time complexity.
Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

See Also

Reference

ICompareContext Interface
ICompareContext Members
CommentsWereChanged Method