Place semicolon before inline comment

[rwestMSFT]

Update the Transact-SQL script generator to ensure that semicolons are correctly placed before any trailing comments (both single-line and block comments) when generating SQL scripts with preserved comments. This prevents semicolons from being included as part of a comment, which could cause issues in SQL execution or readability.

The changes introduce a new method (GenerateStatementWithSemiColon) to handle this logic, and update all relevant code paths to use it.

• Added a new private state (_suppressTrailingComments and _suppressTrailingCommentsAfterIndex) and logic to the SqlScriptGeneratorVisitor to allow deferring the emission of trailing comments until after the semicolon is generated, ensuring the semicolon is not included in the comment text. [1] [2] [3]
• Introduced the GenerateStatementWithSemiColon method, which generates a statement, emits the semicolon, and then emits any trailing comments. This method is now used in place of the previous approach wherever statements and their semicolons are generated.
• Updated all statement generation locations (IfStatement, StatementList, TSqlBatch, WhileStatement) to use GenerateStatementWithSemiColon instead of the old pattern, ensuring consistent semicolon placement before comments throughout the codebase. [1] [2] [3] [4] [5]
• Added new unit tests to verify that semicolons are placed before trailing comments for single statements, multiple statements, and block comments, and that comments are preserved as expected. These tests ensure the new behavior works correctly and guards against regressions.

(This description was generated with the assistance of Copilot.)

In addition, go through the checklist below and check each item as you validate it is either handled or not applicable to this change.

Code Changes

• Unit tests are added, if possible
• Existing tests are passing
• New or updated code follows the guidelines here