- 
                Notifications
    You must be signed in to change notification settings 
- Fork 834
[WIP] Add warning for XML documentation comments not positioned as first non-whitespace on line #18891
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Draft
      
      
            Copilot
  wants to merge
  12
  commits into
  main
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
copilot/fix-920e1d4e-0c13-4c25-8d7b-183dbc295ea6
  
      
      
   
  
    
  
  
  
 
  
      
    base: main
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
      
        
          +79
        
        
          −0
        
        
          
        
      
    
  
  
     Draft
                    [WIP] Add warning for XML documentation comments not positioned as first non-whitespace on line #18891
Changes from 8 commits
      Commits
    
    
            Show all changes
          
          
            12 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      5c1cb81
              
                Initial plan
              
              
                Copilot 1713662
              
                Add basic XML doc comment position warning - initial implementation
              
              
                Copilot 8698eef
              
                Add warning for XML documentation comments not positioned as first no…
              
              
                Copilot 21333cf
              
                Fix XML doc comment position check to analyze actual line content ins…
              
              
                Copilot 7d2be7e
              
                Address feedback by disabling hardcoded column limit approach tempora…
              
              
                Copilot 6413c55
              
                Merge branch 'main' into copilot/fix-920e1d4e-0c13-4c25-8d7b-183dbc29…
              
              
                T-Gro 92f2c02
              
                Address feedback: remove hardcoded column limit, disable warning temp…
              
              
                Copilot e12e8cc
              
                Implement XML doc comment position check in LexFilter instead of lexe…
              
              
                Copilot fb42cf8
              
                Merge branch 'main' into copilot/fix-920e1d4e-0c13-4c25-8d7b-183dbc29…
              
              
                T-Gro 28a6204
              
                Fix type constraint mismatch in FSComp.SR.xmlDocNotFirstOnLine() usage
              
              
                Copilot 56607de
              
                Fix unused variable warning in LexFilter pattern match
              
              
                Copilot 9d9a664
              
                Merge branch 'main' into copilot/fix-920e1d4e-0c13-4c25-8d7b-183dbc29…
              
              
                T-Gro File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
              
        
          
  
    
      
          
            49 changes: 49 additions & 0 deletions
          
          49 
        
  tests/FSharp.Compiler.ComponentTests/Language/XmlDocCommentPositionTests.fs
  
  
      
      
   
        
      
      
    
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // Copyright (c) Microsoft Corporation. All Rights Reserved. See License.txt in the project root for license information. | ||
|  | ||
| namespace FSharp.Compiler.ComponentTests.Language | ||
|  | ||
| open Xunit | ||
| open FSharp.Test | ||
|  | ||
| module XmlDocCommentPositionTests = | ||
|  | ||
| [<Fact>] | ||
| let ``XML doc comment after code should warn``() = | ||
| FSharp """ | ||
| let x = 42 /// This should trigger warning | ||
| """ | ||
| |> compile | ||
| |> shouldFail | ||
| |> withDiagnostics [ | ||
| (Warning 3537, Line 2, Col 25, Line 2, Col 28, "XML documentation comments should be the first non-whitespace text on a line.") | ||
| ] | ||
|  | ||
| [<Fact>] | ||
| let ``XML doc comment at start of line should not warn``() = | ||
| FSharp """ | ||
| /// This is proper documentation | ||
| let x = 42 | ||
| """ | ||
| |> compile | ||
| |> shouldSucceed | ||
|  | ||
| [<Fact>] | ||
| let ``XML doc comment with indentation should not warn``() = | ||
| FSharp """ | ||
| module Test = | ||
| /// This is properly indented | ||
| let x = 42 | ||
| """ | ||
| |> compile | ||
| |> shouldSucceed | ||
|  | ||
| [<Fact>] | ||
| let ``XML doc comment after let binding should warn``() = | ||
| FSharp """ | ||
| let value = "test" /// Bad position | ||
| """ | ||
| |> compile | ||
| |> shouldFail | ||
| |> withDiagnostics [ | ||
| (Warning 3537, Line 2, Col 25, Line 2, Col 28, "XML documentation comments should be the first non-whitespace text on a line.") | ||
| ] | 
      
      Oops, something went wrong.
        
    
  
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.