Added a list of items in the EnvLoader.LoadEnv method documentation

MrDave1999 · Nov 22, 2022 · 16605f5 · 16605f5
1 parent 0d569b2
commit 16605f5
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/Loader/IEnvLoader.cs b/src/Loader/IEnvLoader.cs
@@ -17,7 +17,14 @@ public interface IEnvLoader
     /// <summary>
     /// Loads an .env file based on the environment (development, test, staging or production).
     /// This method will load these .env files in the following order:
-    /// .env.[environment].local, .env.local, .env.[environment], .env
+    /// <list type="bullet">
+    /// <item><c>.env.[environment].local</c> (has the highest priority).</item>
+    /// <item><c>.env.local</c></item>
+    /// <item><c>.env.[environment]</c></item>
+    /// <item><c>.env</c> (has the lowest priority).</item>
+    /// </list>
+    /// The <c>environment</c> is specified by the actual environment variable <c>DOTNET_ENV</c>.
+    /// <para>It should be noted that the default environment will be <c>development</c> or <c>dev</c> if the environment is never specified with <c>DOTNET_ENV</c>.</para>
     /// </summary>
     /// <inheritdoc cref="Load()" />
     IEnvironmentVariablesProvider LoadEnv();