Skip to content

Commit 7911e70

Browse files
Do not separate header comments from function definitions (#105754)
* Do not separate header comments from function definitions Separating them with a space defeats a VS feature that shows the header comments when you hover over a function in code. * Remove // static as well
1 parent 9afb008 commit 7911e70

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

Diff for: docs/coding-guidelines/clr-jit-coding-conventions.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ If you can formulate any assumptions as asserts in the code itself, you should d
777777
// More detailed notes about the function.
778778
// What errors can the function return?
779779
// What other methods are related or alternatives to be considered?
780-
780+
//
781781
<function definition>
782782
```
783783

@@ -805,8 +805,7 @@ The following is a sample of a completed function definition:
805805
// Notes:
806806
// Call-site signature blobs include ELEMENT_TYPE_SENTINEL.
807807
// This method does not check for the presence of the sentinel.
808-
809-
// static
808+
//
810809
BOOL MetaSig::IsVarArg(Module* pModule,
811810
PCCOR_SIGNATURE pSig)
812811
{

0 commit comments

Comments
 (0)