File Naming Convention.md changed (mode: 100644) (index 6c7bcc1..4563cd5) |
14 |
14 |
* [Code Folder Naming Convention](#code-folder-naming-convention) |
* [Code Folder Naming Convention](#code-folder-naming-convention) |
15 |
15 |
|
|
16 |
16 |
|
|
17 |
|
# File Name |
|
18 |
|
* Make file names lowercase. |
|
19 |
|
* Separate words with underscores. |
|
20 |
|
* Use only standard ASCII alphanumeric characters in file and directory names. |
|
21 |
|
|
|
22 |
|
* Recommended |
|
23 |
|
|
|
24 |
|
|
|
25 |
|
Example | file_name.extension | |
|
26 |
|
---------|---------------------| |
|
27 |
|
|
|
28 |
|
# Folder Name |
|
29 |
|
* Folder Name should be meaningful. |
|
30 |
|
* Make folder names lowercase. |
|
31 |
|
|
|
32 |
|
# Figure Name |
|
33 |
|
|
|
34 |
|
* Figures Names should follow the Underscore Case. |
|
35 |
|
* everything is in lower case and the words are separated by underscores. |
|
36 |
|
* This convention is also popularly known as snake case |
|
37 |
|
|
|
38 |
|
| Example | figure_name.svg | |
|
39 |
|
| ---------- | --------------- | |
|
40 |
|
|
|
41 |
|
# Tag Name |
|
42 |
|
|
|
43 |
|
* Create descriptive names |
|
44 |
|
* Create short and simple names |
|
45 |
|
* Avoid "-". If you name something "first-name", some software may think you want to subtract "name" from "first". |
|
46 |
|
* Avoid ".". If you name something "first.name", some software may think that "name" is a property of the object "first". |
|
47 |
|
* Avoid ":". Colons are reserved for namespaces (more later). |
|
48 |
|
|
|
49 |
|
# Link Name |
|
50 |
|
|
|
51 |
|
|
|
52 |
17 |
|
|
53 |
18 |
# Code Folder Naming Convention |
# Code Folder Naming Convention |
54 |
19 |
|
|
|
61 |
26 |
#### JAVA |
#### JAVA |
62 |
27 |
* JAVA Files in Code Folder. |
* JAVA Files in Code Folder. |
63 |
28 |
* Every JAVA file name will be written as UpperCamelCase. |
* Every JAVA file name will be written as UpperCamelCase. |
64 |
|
|
|
|
29 |
|
* Words are smashed together and the first letter of each word is capitalized. No word separator, like the underscore _, is used. |
65 |
30 |
|
|
66 |
31 |
| Example | FileName.java | |
| Example | FileName.java | |
67 |
32 |
| ----------- | ------------- | |
| ----------- | ------------- | |
68 |
|
* Classes and Interfaces |
|
69 |
|
* Class names should be nouns, in mixed case with the first letter of each internal word capitalised. |
|
70 |
|
* Interfaces name should also be capitalised just like class names. |
|
71 |
|
* Use whole words and must avoid acronyms and abbreviations. |
|
72 |
33 |
|
|
73 |
|
| Example | class MountainBike | interface Sport | |
|
74 |
|
| ----------- | ----------- | ----------- | |
|
|
34 |
|
* If there is any version/number, it should be written as, |
|
35 |
|
| Example | FileName01.java | FileName02.java | |
|
36 |
|
| ----------- | --------------- | --------------- | |
|
37 |
|
|
|
38 |
|
* Classes and Interfaces Names |
|
39 |
|
* Class and interface names are generally noun or noun phrases. |
|
40 |
|
* Class and interface must begin with a capital letter. |
|
41 |
|
|
|
42 |
|
|interface Example | interface AqueousHabitat { ... } | |
|
43 |
|
| -------------------- | -------------------------------- | |
|
44 |
|
|
|
45 |
|
|Class Example | class FishBowl implements AqueousHabitat { ... } | |
|
46 |
|
| -------------------- | ------------------------------------------------ | |
75 |
47 |
|
|
76 |
48 |
* Variables : Variable names should be short yet meaningful. |
* Variables : Variable names should be short yet meaningful. |
77 |
49 |
* Should not start with underscore(‘_’) or dollar sign ‘$’ characters. |
* Should not start with underscore(‘_’) or dollar sign ‘$’ characters. |
|
105 |
77 |
| ----------- | ---------- | |
| ----------- | ---------- | |
106 |
78 |
|
|
107 |
79 |
|
|
|
80 |
|
# File Name |
|
81 |
|
* Make file names lowercase. |
|
82 |
|
* Separate words with underscores. |
|
83 |
|
* Use only standard ASCII alphanumeric characters in file and directory names. |
|
84 |
|
|
|
85 |
|
* Recommended |
|
86 |
|
|
|
87 |
|
|
|
88 |
|
Example | file_name.extension | |
|
89 |
|
---------|---------------------| |
|
90 |
|
|
|
91 |
|
# Folder Name |
|
92 |
|
* Folder Name should be meaningful. |
|
93 |
|
* Make folder names lowercase. |
|
94 |
|
|
|
95 |
|
# Figure Name |
|
96 |
|
|
|
97 |
|
* Figures Names should follow the Underscore Case. |
|
98 |
|
* everything is in lower case and the words are separated by underscores. |
|
99 |
|
* This convention is also popularly known as snake case. |
|
100 |
|
|
|
101 |
|
| Example | figure_name.svg | |
|
102 |
|
| ---------- | --------------- | |
|
103 |
|
|
|
104 |
|
# Tag Name |
|
105 |
|
|
|
106 |
|
|
|
107 |
|
|
|
108 |
|
# Link Name |
|
109 |
|
|
|
110 |
|
|
|
111 |
|
|
108 |
112 |
|
|
109 |
113 |
|
|
110 |
114 |
|
|