Improvements to comments and formatting. Minor refactor to reduce code duplication.

Author: tombogle

SIL.Core/IO/TempFile.cs

@@ -51,7 +51,7 @@ private static string MakeFileAtRandomPath(string extension = null)
 			string result = "";
 			while (needMoreTries)
 			{
-				result = Combine(GetTempPath(), (NamePrefix??"") + GetRandomFileName());
+				result = Combine(GetTempPath(), (NamePrefix ?? "") + GetRandomFileName());
 				if (extension != null)
 				{
 					result = ChangeExtension(result, extension);
@@ -73,12 +73,21 @@ private static string MakeFileAtRandomPath(string extension = null)
 			return result;
 		}
 
+		/// <summary>
+		/// Use this constructor to set the path manually later. If
+		/// <paramref name="dontMakeMeAFileAndDontSetPath"/> is <c>false</c>, a temporary file will
+		/// be created and assigned to <see cref="Path"/> (similar to the default constructor,
+		/// except <see cref="NamePrefix"/> is ignored). If <c>true</c>, no file is created and
+		/// <see cref="Path"/> remains unset.
+		/// </summary>
+		/// <param name="dontMakeMeAFileAndDontSetPath">
+		/// Pass <c>true</c> to skip creating a temp file and leave <see cref="Path"/> unset.
+		/// Caller is responsible for setting it later.
+		/// </param>
 		public TempFile(bool dontMakeMeAFileAndDontSetPath)
 		{
-			if(!dontMakeMeAFileAndDontSetPath)
-			{
+			if (!dontMakeMeAFileAndDontSetPath)
 				Path = GetTempFileName();
-			}
 		}
 
 		/// <summary>

SIL.TestUtilities/TempLiftFile.cs

@@ -2,12 +2,13 @@
 using System.IO;
 using JetBrains.Annotations;
 using SIL.IO;
+using static System.IO.Path;
 
 namespace SIL.TestUtilities
 {
 	public class TempLiftFile : TempFile
 	{
-		private const string LiftFileExt = ".lift";
+		private const string kLiftFileExt = ".lift";
 
 		public TempLiftFile(string xmlOfEntries)
 			: this(xmlOfEntries, /*LiftIO.Validation.Validator.LiftVersion*/ "0.12")
@@ -19,34 +20,25 @@ public TempLiftFile(string xmlOfEntries, string claimedLiftVersion)
 		}
 
 		public TempLiftFile(TemporaryFolder parentFolder, string xmlOfEntries, string claimedLiftVersion)
-			: base(true) // True means "I'll set the pathname, thank you very much." Otherwise, the temp one 'false' creates will stay forever, and fill the hard drive up.
+			: base(dontMakeMeAFileAndDontSetPath: true)
 		{
-			if (parentFolder != null)
-			{
-				Path = parentFolder.GetPathForNewTempFile(false) + LiftFileExt;
-			}
-			else
-			{
-				Path = System.IO.Path.Combine(System.IO.Path.GetTempPath(), System.IO.Path.GetRandomFileName() + LiftFileExt);
-			}
+			Path = parentFolder != null
+				? parentFolder.GetPathForNewTempFile(false) + kLiftFileExt
+				: Combine(GetTempPath(), GetRandomFileName() + kLiftFileExt);
 
-			string liftContents =
-				$"<?xml version='1.0' encoding='utf-8'?><lift version='{claimedLiftVersion}'>{xmlOfEntries}</lift>";
-			RobustFile.WriteAllText(Path, liftContents);
+			WriteContents(xmlOfEntries, claimedLiftVersion);
 		}
 
 		public TempLiftFile(string fileName, TemporaryFolder parentFolder, string xmlOfEntries, string claimedLiftVersion)
-			: base(true) // True means "I'll set the pathname, thank you very much." Otherwise, the temp one 'false' creates will stay forever, and fill the hard drive up.
+			: base(dontMakeMeAFileAndDontSetPath: true)
 		{
 			Path = parentFolder.Combine(fileName);
 
-			string liftContents =
-				$"<?xml version='1.0' encoding='utf-8'?><lift version='{claimedLiftVersion}'>{xmlOfEntries}</lift>";
-			RobustFile.WriteAllText(Path, liftContents);
+			WriteContents(xmlOfEntries, claimedLiftVersion);
 		}
 
 		private TempLiftFile()
-			: base(true) // True means "I'll set the pathname, thank you very much." Otherwise, the temp one 'false' creates will stay forever, and fill the hard drive up.
+			: base(dontMakeMeAFileAndDontSetPath: true)
 		{
 		}
 
@@ -61,5 +53,12 @@ private TempLiftFile()
 			t.Path = path;
 			return t;
 		}
+
+		private void WriteContents(string xmlOfEntries, string claimedLiftVersion)
+		{
+			var liftContents = "<?xml version='1.0' encoding='utf-8'?>" +
+				$"<lift version='{claimedLiftVersion}'>{xmlOfEntries}</lift>";
+			RobustFile.WriteAllText(Path, liftContents);
+		}
 	}
 }