File Naming Convention.md changed (mode: 100644) (index 32ecf4d..6c7bcc1) |
1 |
1 |
# Naming Convention Standard/File Name Conventions |
# Naming Convention Standard/File Name Conventions |
2 |
2 |
|
|
3 |
|
## A collection of guidelines for writing file, folder, classes, figures, and images names in the project. |
|
|
3 |
|
### A collection of guidelines for writing file, folder, classes, figures, and images names in the project. These guidelines should help you toward that goal of not only correct code, but understandable. |
|
4 |
|
|
|
5 |
|
* Our working directory is |
|
6 |
|
|
|
7 |
|
 |
4 |
8 |
|
|
5 |
9 |
* [File Names](#file-name) |
* [File Names](#file-name) |
6 |
10 |
* [Figures](#figure-name) |
* [Figures](#figure-name) |
|
11 |
15 |
|
|
12 |
16 |
|
|
13 |
17 |
# File Name |
# File Name |
14 |
|
* Make file and directory names lowercase. |
|
15 |
|
* Separate words with hyphens, not underscores. |
|
|
18 |
|
* Make file names lowercase. |
|
19 |
|
* Separate words with underscores. |
16 |
20 |
* Use only standard ASCII alphanumeric characters in file and directory names. |
* Use only standard ASCII alphanumeric characters in file and directory names. |
17 |
21 |
|
|
18 |
22 |
* Recommended |
* Recommended |
19 |
23 |
|
|
20 |
24 |
|
|
21 |
|
Example | file-name.extension | |
|
|
25 |
|
Example | file_name.extension | |
22 |
26 |
---------|---------------------| |
---------|---------------------| |
23 |
|
|
|
24 |
|
* Not Recommended |
|
25 |
|
|
|
26 |
|
|
|
27 |
|
Example | filename.extension | |
|
28 |
|
---------|--------------------| |
|
29 |
|
|
|
30 |
|
Example | fileName.extension | |
|
31 |
|
---------|--------------------| |
|
32 |
|
|
|
33 |
|
* Other exceptions |
|
34 |
|
|
|
35 |
|
* It's okay to have some inconsistency in filenames if it can't otherwise be avoided. |
|
36 |
|
* 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. |
|
37 |
27 |
|
|
38 |
28 |
# Folder Name |
# Folder Name |
39 |
|
* The source code, hosted at <https://rocketgit.com/user/caubert/CSCI_3410>, is organized as follows: |
|
40 |
|
|
|
41 |
|
 |
|
42 |
|
|
|
43 |
|
* following lowercase convention for folder names. |
|
|
29 |
|
* Folder Name should be meaningful. |
|
30 |
|
* Make folder names lowercase. |
44 |
31 |
|
|
45 |
32 |
# Figure Name |
# Figure Name |
46 |
33 |
|
|
|
73 |
60 |
|
|
74 |
61 |
#### JAVA |
#### JAVA |
75 |
62 |
* JAVA Files in Code Folder. |
* JAVA Files in Code Folder. |
76 |
|
* Every JAVA file will be followed by the with a capital letter or first word with a lowercase letter, rest all with capital. |
|
|
63 |
|
* Every JAVA file name will be written as UpperCamelCase. |
|
64 |
|
|
77 |
65 |
|
|
|
66 |
|
| Example | FileName.java | |
|
67 |
|
| ----------- | ------------- | |
78 |
68 |
* Classes and Interfaces |
* Classes and Interfaces |
79 |
69 |
* Class names should be nouns, in mixed case with the first letter of each internal word capitalised. |
* Class names should be nouns, in mixed case with the first letter of each internal word capitalised. |
80 |
70 |
* Interfaces name should also be capitalised just like class names. |
* Interfaces name should also be capitalised just like class names. |
|
151 |
141 |
* https://developers.google.com/style/filenames. |
* https://developers.google.com/style/filenames. |
152 |
142 |
* https://guides.lib.purdue.edu/c.php?g=353013&p=2378293 |
* https://guides.lib.purdue.edu/c.php?g=353013&p=2378293 |
153 |
143 |
* https://dev.to/danialmalik/a-beginner-s-guide-to-clean-code-part1-naming-conventions-139l |
* https://dev.to/danialmalik/a-beginner-s-guide-to-clean-code-part1-naming-conventions-139l |
|
144 |
|
* https://www.cs.cornell.edu/courses/JavaAndDS/JavaStyle.html |