Skip to content

Commit ed4e512

Browse files
committed
Added comments to function app classes.
1 parent a74ee15 commit ed4e512

File tree

3 files changed

+61
-7
lines changed

3 files changed

+61
-7
lines changed

LiquidFunctions/LiquidFunction.cs

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,27 @@
1313

1414
namespace LiquidFunctions
1515
{
16+
/// <summary>
17+
/// Azure Function that processes HTTP requests and returns a personalized greeting.
18+
/// </summary>
1619
public class LiquidFunction
1720
{
1821
private readonly ILogger<LiquidFunction> _logger;
1922

23+
/// <summary>
24+
/// Constructor that accepts an ILogger instance for logging.
25+
/// </summary>
26+
/// <param name="log">ILogger instance for logging information.</param>
2027
public LiquidFunction(ILogger<LiquidFunction> log)
2128
{
2229
_logger = log;
2330
}
2431

32+
/// <summary>
33+
/// This method is triggered by an HTTP request. It accepts a 'name' parameter via query string or request body and returns a personalized message.
34+
/// </summary>
35+
/// <param name="req">The HTTP request that triggers this function.</param>
36+
/// <returns>A personalized greeting message.</returns>
2537
[FunctionName("LiquidFunction")]
2638
[OpenApiOperation(operationId: "Run", tags: new[] { "name" })]
2739
[OpenApiSecurity("function_key", SecuritySchemeType.ApiKey, Name = "code", In = OpenApiSecurityLocationType.Query)]
@@ -30,20 +42,26 @@ public LiquidFunction(ILogger<LiquidFunction> log)
3042
public async Task<IActionResult> Run(
3143
[HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req)
3244
{
45+
// Log the receipt of an HTTP request
3346
_logger.LogInformation("C# HTTP trigger function processed a request.");
3447

48+
// Retrieve the 'name' parameter from the query string
3549
string name = req.Query["name"];
3650

51+
// Read the request body as a string
3752
string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
3853
dynamic data = JsonConvert.DeserializeObject(requestBody);
39-
name = name ?? data?.name;
4054

55+
// Use the 'name' from the request body if it wasn't provided in the query string
56+
name ??= data?.name;
57+
58+
// Create a response message
4159
string responseMessage = string.IsNullOrEmpty(name)
4260
? "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."
4361
: $"Hello, {name}. This HTTP triggered function executed successfully.";
4462

63+
// Return an OK result with the response message
4564
return new OkObjectResult(responseMessage);
4665
}
4766
}
48-
}
49-
67+
}

SolidFunctions/SolidFunction.cs

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,27 @@
1313

1414
namespace DeployMultipleFunctions
1515
{
16+
/// <summary>
17+
/// Azure Function that processes HTTP requests and returns a personalized greeting.
18+
/// </summary>
1619
public class SolidFunction
1720
{
1821
private readonly ILogger<SolidFunction> _logger;
1922

23+
/// <summary>
24+
/// Constructor that accepts an ILogger instance for logging.
25+
/// </summary>
26+
/// <param name="log">ILogger instance for logging information.</param>
2027
public SolidFunction(ILogger<SolidFunction> log)
2128
{
2229
_logger = log;
2330
}
2431

32+
/// <summary>
33+
/// This method is triggered by an HTTP request. It accepts a 'name' parameter via query string or request body and returns a personalized message.
34+
/// </summary>
35+
/// <param name="req">The HTTP request that triggers this function.</param>
36+
/// <returns>A personalized greeting message.</returns>
2537
[FunctionName("SolidFunction")]
2638
[OpenApiOperation(operationId: "Run", tags: new[] { "name" })]
2739
[OpenApiSecurity("function_key", SecuritySchemeType.ApiKey, Name = "code", In = OpenApiSecurityLocationType.Query)]
@@ -30,20 +42,26 @@ public SolidFunction(ILogger<SolidFunction> log)
3042
public async Task<IActionResult> Run(
3143
[HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req)
3244
{
45+
// Log the receipt of an HTTP request
3346
_logger.LogInformation("C# HTTP trigger function processed a request.");
3447

48+
// Retrieve the 'name' parameter from the query string
3549
string name = req.Query["name"];
3650

51+
// Read the request body as a string
3752
string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
3853
dynamic data = JsonConvert.DeserializeObject(requestBody);
54+
55+
// Use the 'name' from the request body if it wasn't provided in the query string
3956
name = name ?? data?.name;
4057

58+
// Create a response message
4159
string responseMessage = string.IsNullOrEmpty(name)
4260
? "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."
4361
: $"Hello, {name}. This HTTP triggered function executed successfully.";
4462

63+
// Return an OK result with the response message
4564
return new OkObjectResult(responseMessage);
4665
}
4766
}
48-
}
49-
67+
}

SolidusFunctions/SolidusFunctions.cs

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,27 @@
1313

1414
namespace SolidusFunctions
1515
{
16+
/// <summary>
17+
/// Azure Function that processes HTTP requests and returns a personalized greeting.
18+
/// </summary>
1619
public class SolidusFunctions
1720
{
1821
private readonly ILogger<SolidusFunctions> _logger;
1922

23+
/// <summary>
24+
/// Constructor that accepts an ILogger instance for logging.
25+
/// </summary>
26+
/// <param name="log">ILogger instance for logging information.</param>
2027
public SolidusFunctions(ILogger<SolidusFunctions> log)
2128
{
2229
_logger = log;
2330
}
2431

32+
/// <summary>
33+
/// This method is triggered by an HTTP request. It accepts a 'name' parameter via query string or request body and returns a personalized message.
34+
/// </summary>
35+
/// <param name="req">The HTTP request that triggers this function.</param>
36+
/// <returns>A personalized greeting message.</returns>
2537
[FunctionName("SolidusFunction")]
2638
[OpenApiOperation(operationId: "Run", tags: new[] { "name" })]
2739
[OpenApiSecurity("function_key", SecuritySchemeType.ApiKey, Name = "code", In = OpenApiSecurityLocationType.Query)]
@@ -30,20 +42,26 @@ public SolidusFunctions(ILogger<SolidusFunctions> log)
3042
public async Task<IActionResult> Run(
3143
[HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req)
3244
{
45+
// Log the receipt of an HTTP request
3346
_logger.LogInformation("C# HTTP trigger function processed a request.");
3447

48+
// Retrieve the 'name' parameter from the query string
3549
string name = req.Query["name"];
3650

51+
// Read the request body as a string
3752
string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
3853
dynamic data = JsonConvert.DeserializeObject(requestBody);
54+
55+
// Use the 'name' from the request body if it wasn't provided in the query string
3956
name = name ?? data?.name;
4057

58+
// Create a response message
4159
string responseMessage = string.IsNullOrEmpty(name)
4260
? "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."
4361
: $"Hello, {name}. This HTTP triggered function executed successfully.";
4462

63+
// Return an OK result with the response message
4564
return new OkObjectResult(responseMessage);
4665
}
4766
}
48-
}
49-
67+
}

0 commit comments

Comments
 (0)