Repository navigation
[Docs]: Code comments that no longer match the code #2616
Description
Activity
- added a commit that references this issue
on Oct 9, 2026 Done in #2659. Comments only, so it ships with the next release rather than making one.
Each item was re-read against the code before it changed. Two had been corrected since this was written and still carried a count nothing keeps true, so the number went:
NavItem's progress signals (38 and 12 again after #2646) and the refresh spellings inViewModelBaseand the F5 guard (15 after #2598, withScanLargeFilesCommandalready gone). The rest now say what the code does:AdminBanner.xamlcitesTheElevationBanner_LivesInOneControl_AndItsHostsExposeWhatItBindsand serves every privileged tab, 31 today; the same count leftAdminBanner.xaml.csand that guard's remarks, comment and failure message.AtomicFile: three retries, four attempts in all.UpdateService.VerifyHashAsync: false for a mismatch, a.sha256that cannot be downloaded or parsed, an unreadable file or a cancellation, and false means the update is not installed.App.xaml: three layout strategies, named.FileLockService: "this file uses classic[DllImport]"; eight files declare it today.AudioMixerService: the Core Audio interfaces without a count, what is held across polls since [Bug]: Volume Control — an app sent to another output device loses its row's level, and leaves the list once it restarts #2652, a singleton disposed with the container, and the_groupskey, which is the app key from the session-instance identifier rather than a PID string.SystemFixService: Windows Update and WinGet; the network-stack reset is on Network Repair.SystemFixesViewModel: the two desktop fixes are listed, and run as the user.BandwidthMonitorViewModel: the Network group.
Nine more comments name a test by a name it no longer has; they are listed in #2658, with a check that keeps a cited name true.
Problem
Comments a contributor will trust, each contradicted by the code beside it:
ViewModels/NavItem.cs:125-128: "37 view-models set IsProgressIndeterminate and 10 set Progress", and Deep Cleanup, File Shredder and Speed Test are "in the second group". 7 setProgress, and those three set neither (see the taskbar issue).ViewModels/ViewModelBase.cs:90-96andSysManager.Tests/ArchitectureTests.cs:2876-2884: "12 distinct spellings" of the refresh command, andScanLargeFilesCommand. There are 11, and that command no longer exists (Large Files is its own tab).Views/AdminBanner.xaml:21: citesArchitectureTests.EveryAdminBannerHost_ExposesWhatTheBannerBinds; the test isTheElevationBanner_LivesInOneControl_AndItsHostsExposeWhatItBinds.:39says the control "serves all 30 privileged tabs"; it serves 31.Helpers/AtomicFile.cs:230: "Three attempts in all". It is four: the first try and three retries.Services/UpdateService.cs:322: hash verification "is best-effort — network errors don't block install". A missing or unreadable hash refuses the update.App.xaml:159: "the two layout strategies in the project docs". There are three.Services/FileLockService.cs:23: "the one place we use classic [DllImport]". Seven files use it, 13 declarations.Services/AudioMixerService.cs:17,:40-41: interop "for the seven" interfaces, and a tab "created/destroyed on navigation". There are ten interfaces, and the service is a singleton disposed with the container.Services/SystemFixService.cs:10: lists the network stack among its repairs; those resets live on Network Repair (the same file says so at:94).ViewModels/SystemFixesViewModel.cs:21: "Repairs require administrator rights". The two desktop fixes do not.ViewModels/BandwidthMonitorViewModel.cs:25: "(Monitor group)". Bandwidth Monitor is in the Network group.Expected behavior
Each comment says what the code does now. Where a comment carries a count, it either goes or names the guard that keeps the count true.
Affected tab
Code comments only, no behaviour change