Backend Conventions - DDavis34/Roll-Call GitHub Wiki

Variables

When naming variables associated with processes in the backend, the naming conventions should be as follows:

private readonly Supabase.Client _client;

private readonly ILogger<SupabaseAuthService> _logger;

with an underscore before the name. This will make it easier to keep track of where system calls are being made in larger code blocks.

Documentation

All backend code should also be well documented, so that the debugging process can be much easier. For example, for each method, it should be documented as follows:

/* @function, @parameters, @return */

where @function describes the process the method undertakes, @parameters describes the input parameters of the function, and @return describes the output of the given method.