starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-09-25 00:15:10 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Guidance around const by-value function parameters #1358

New Issue
Open
opened 2026-01-30 22:23:34 +00:00 by claunia · 6 comments
claunia commented 2026-01-30 22:23:34 +00:00
Owner
Copy Link

Originally created by @dlong11 on GitHub (May 25, 2019).

Clarification is needed around const by-value function parameters. I noticed in a lot of the code, by-value function parameters are marked const. Some code doesn't follow this rule though.

Examples in interactivity/win32/Clipboard.cpp

void Clipboard::Copy(bool fAlsoCopyHtml)

void Clipboard::StoreSelectionToClipboard(bool const fAlsoCopyHtml)

In the CppCoreGuidelines
Con.1: By default, make objects immutable

They have an exception
Exception
Function arguments are rarely mutated, but also rarely declared const. To avoid confusion and lots of false positives, don't enforce this rule for function arguments.

void g(const int i); // pedantic

What is the team's stance on this?

This issue is just a reminder when we create the styleguide in #890 to include something around the team's rule.

Originally created by @dlong11 on GitHub (May 25, 2019). Clarification is needed around const by-value function parameters. I noticed in a lot of the code, by-value function parameters are marked const. Some code doesn't follow this rule though. Examples in interactivity/win32/Clipboard.cpp void Clipboard::Copy(bool fAlsoCopyHtml) void Clipboard::StoreSelectionToClipboard(bool const fAlsoCopyHtml) In the CppCoreGuidelines [Con.1: By default, make objects immutable](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#con1-by-default-make-objects-immutable) They have an exception Exception Function arguments are rarely mutated, but also rarely declared const. To avoid confusion and lots of false positives, don't enforce this rule for function arguments. > void g(const int i); // pedantic What is the team's stance on this? This issue is just a reminder when we create the styleguide in #890 to include something around the team's rule.
claunia added the Issue-DocsProduct-MetaArea-CodeHealth labels 2026-01-30 22:23:34 +00:00
claunia commented 2026-01-30 22:23:34 +00:00
Author
Owner
Copy Link

@dlong11 commented on GitHub (May 25, 2019):

I just noticed another minor issue with the posted code from Clipboard.cpp. The StoreSelectionToClipboard method doesn't follow NL.26: Use conventional const notation.

@dlong11 commented on GitHub (May 25, 2019): I just noticed another minor issue with the posted code from Clipboard.cpp. The StoreSelectionToClipboard method doesn't follow NL.26: Use conventional const notation.
claunia commented 2026-01-30 22:23:35 +00:00
Author
Owner
Copy Link

@adiviness commented on GitHub (May 25, 2019):

Generally we put const wherever we can, including function parameters. The exception to that is if the param is going to be modified by the function, it makes more sense to modify the copied by value variable than to make an internal copy to modify.

I’m of the opinion that we should follow the conventional const notation.

@adiviness commented on GitHub (May 25, 2019): Generally we put const wherever we can, including function parameters. The exception to that is if the param is going to be modified by the function, it makes more sense to modify the copied by value variable than to make an internal copy to modify. I’m of the opinion that we should follow the conventional const notation.
claunia commented 2026-01-30 22:23:35 +00:00
Author
Owner
Copy Link

@binarycrusader commented on GitHub (May 30, 2019):

I have to agree with @adiviness, I apply const liberally everywhere I can. const declares intent and the compiler enforces that intent. I know not everyone loves it, but for me it's proved helpful.

@binarycrusader commented on GitHub (May 30, 2019): I have to agree with @adiviness, I apply const liberally everywhere I can. const declares intent and the compiler enforces that intent. I know not everyone loves it, but for me it's proved helpful.
claunia commented 2026-01-30 22:23:35 +00:00
Author
Owner
Copy Link

@dlong11 commented on GitHub (May 30, 2019):

I have no opinion on this. I just want to make sure this kind of stuff is added to the style guide if this is the team's rule. Having this expectation documented helps when writing and reviewing code. It is so much easier to say "The style guide suggests using const on by-value function params ....." Prevents bikeshedding. You guys can discuss whether this is a rule, recommendation, preference, etc... 😄

@dlong11 commented on GitHub (May 30, 2019): I have no opinion on this. I just want to make sure this kind of stuff is added to the style guide if this is the team's rule. Having this expectation documented helps when writing and reviewing code. It is so much easier to say "The style guide suggests using const on by-value function params ....." Prevents bikeshedding. You guys can discuss whether this is a rule, recommendation, preference, etc... 😄
claunia commented 2026-01-30 22:23:35 +00:00
Author
Owner
Copy Link

@dlong11 commented on GitHub (Jun 5, 2019):

I missed linking this to the Coding Style issue. #890

@dlong11 commented on GitHub (Jun 5, 2019): I missed linking this to the Coding Style issue. #890
claunia commented 2026-01-30 22:23:35 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Aug 22, 2023):

I'm tempted to just close this and fold it back up into "we should write some coding style docs"...

@zadjii-msft commented on GitHub (Aug 22, 2023): I'm tempted to just close this and fold it back up into "we should write some coding style docs"...
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-CodeHealth Issue-Docs Product-Meta
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#1358
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?