#   Naming Convention Standard/File Name Conventions

## A collection of guidelines for writing file, folder, classes, figures, and images names in the project.

  * [File Names](#file-name)
  * [Figures](#figure-name)
  * [Folders](#folder-name)
  * [The Tags in the Document](#tag-name)
  * [The Links in the Document](#link-name)
  * [Code Folder Naming Convention](#code-folder-naming-convention)


# File Name
*  Make file and directory names lowercase.
*  Separate words with hyphens, not underscores.
*  Use only standard ASCII alphanumeric characters in  file and directory names.

    * Recommended


        Example | file-name.extension |
       ---------|---------------------|
 
    * Not Recommended


        Example | filename.extension |
       ---------|--------------------|

         Example | fileName.extension |
        ---------|--------------------|

* Other exceptions
  
  * It's okay to have some inconsistency in filenames if it can't otherwise be avoided.
    * For example, sometimes tools that generate reference documentation produce file names based on different style requirements or based on the design and naming conventions of the product or API itself.

# Folder Name
*   The source code, hosted at <https://rocketgit.com/user/caubert/CSCI_3410>, is organized as follows:

![alt text](1.png "Logo Title Text 1")

* following lowercase convention for folder names.

# Figure Name

* Figures Names should follow the Underscore Case.
*  everything is in lower case and the words are separated by underscores.
*  This convention is also popularly known as snake case

    | Example    | figure_name.svg |
    | ---------- | --------------- |

# Tag Name

 * Create descriptive names 
 * Create short and simple names
 * Avoid "-". If you name something "first-name", some software may think you want to subtract "name" from "first".
 * Avoid ".". If you name something "first.name", some software may think that "name" is a property of the object "first".
 * Avoid ":". Colons are reserved for namespaces (more later).

# Link Name



# Code Folder Naming Convention

### In code Folder, we have following folders

1. [JAVA](#java)
2. [SQL](#sql)
3. [XML](#xml)

#### JAVA
* JAVA Files in Code Folder.
    * Every JAVA file will be followed by the with a capital letter or first word with a lowercase letter, rest all with capital.

    * Classes and Interfaces
        * Class names should be nouns, in mixed case with the first letter of each internal word capitalised. 
        * Interfaces name should also be capitalised just like class names.
        * Use whole words and must avoid acronyms and abbreviations.

         | Example     | class MountainBike | interface Sport |
         | ----------- | ----------- | ----------- |

* Variables : Variable names should be short yet meaningful.
    * Should not start with underscore(‘_’) or dollar sign ‘$’ characters.
    * Should be mnemonic i.e, designed to indicate to the casual observer the intent of its use.
    * One-character variable names should be avoided except for temporary variables.
    * Common names for temporary variables are i, j, k, m, and n for integers; c, d, and e for characters.

        | Example     |  int speed = 0 |  int gear = 1; |
        | ----------- | ----------- | ----------- |

* Constant variables: 
  * Should be all uppercase with words separated by underscores (“_”).
  * There are various constants used in predefined classes like Float, Long, String etc.

    | Example     |  static final int MIN_WIDTH = 4; |
    | ----------- | -------------------------------- |

#### SQL

* SQL folder has Homework Files.
    * Every Homework will be followed by HW_ and filename.

        | Example    | HW_HomeworkName |
        | -----------| --------------- |
#### XML
* XML Files in Code Folder
  * Camel case is a common naming rule in JavaScripts.
  * Uppercase first letter in each word except the first

    | Example     |  firstName |
    | ----------- | ---------- |




        
       

















##### *Important* Notes: 

*   Do not use names which could misguide other developers.
*   Names should be meaningfully distinct and pronounceable.





### *Rules* are taken by:
  *  https://www.geeksforgeeks.org/.
  *  https://www.w3schools.com/xml/xml_elements.asp.
  *  https://developers.google.com/style/filenames.
  *  https://guides.lib.purdue.edu/c.php?g=353013&p=2378293
  *  https://dev.to/danialmalik/a-beginner-s-guide-to-clean-code-part1-naming-conventions-139l