VcPkg files: Simplify header comment handling (#2135)

cmake-modules/AzureVcpkg.cmake

@@ -54,21 +54,13 @@ macro(az_vcpkg_portfile_prep targetName fileName contentToRemove)
 endmacro()
 
 macro(az_vcpkg_export targetName macroNamePart dllImportExportHeaderPath)
-  # The vcpkg.json file has an extra '#' in the comment section, because VcPkg can't handle an empty line at that position,
-  # and without that extra '#' line, the file contents look too crowded.
-  # Ultimately, the lines passed to az_vcpkg_portfile_prep() have to match the header comment that is actually
-  # present in the files, or otherwise nothing will be removed.
-  az_vcpkg_portfile_prep(
-    "${targetName}"
-    "vcpkg.json"
-    "# Copyright (c) Microsoft Corporation. All rights reserved.\n# SPDX-License-Identifier: MIT\n#\n"
-  )
-
-  az_vcpkg_portfile_prep(
-    "${targetName}"
-    "portfile.cmake"
-    "# Copyright (c) Microsoft Corporation. All rights reserved.\n# SPDX-License-Identifier: MIT\n\n"
-  )
+  foreach(vcpkgFile "vcpkg.json" "portfile.cmake")
+    az_vcpkg_portfile_prep(
+      "${targetName}"
+      "${vcpkgFile}"
+      "# Copyright (c) Microsoft Corporation. All rights reserved.\n# SPDX-License-Identifier: MIT\n\n"
+    )
+  endforeach()
 
   # Standard names for folders such as "bin", "lib", "include". We could hardcode, but some other libs use it too (curl).
   include(GNUInstallDirs)

sdk/core/azure-core/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-core-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/identity/azure-identity/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-identity-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/keyvault/azure-security-keyvault-common/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-security-keyvault-common-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/keyvault/azure-security-keyvault-keys/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-security-keyvault-keys-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/storage/azure-storage-blobs/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-storage-blobs-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/storage/azure-storage-common/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-storage-common-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/storage/azure-storage-files-datalake/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-storage-files-datalake-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/storage/azure-storage-files-shares/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-storage-files-shares-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",

sdk/template/azure-template/vcpkg/vcpkg.json

@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # SPDX-License-Identifier: MIT
-#
+
 {
   "name": "azure-template-cpp",
   "version-string": "@AZ_LIBRARY_VERSION@",