How Do You Document Naming Conventions?

by | Last updated on January 24, 2024

, , , ,

Avoid special characters or spaces in a file

name

.

Use capitals and underscores

instead of periods or spaces or slashes. Use date format ISO 8601: YYYYMMDD.

What is a suitable naming convention?

Date of creation (putting the date in the front will facilitate computer aided date sorting)

Short Description

.

Work

.

Location

.

Project name or number

.

What are file naming conventions in DOS?

On MS-DOS, file names are

case-insensitive and limited to eight characters, plus optionally a period and three more characters

. Emacs knows enough about these limitations to handle file names that were meant for other operating systems. For instance, leading dots ‘ .

How can you differentiate the files with their file naming convention?


Files should be named consistently

.

File names should be short but descriptive

(<25 characters) (Briney, 2015) Avoid special characters or spaces in a file name. Use capitals and underscores instead of periods or spaces or slashes.

What are the 3 things to consider in establishing a naming convention?

Component names should be relatively short, yet meaningful. A component name can have up to 50 characters, including letters, numbers, and some symbols. However, the first character must be a letter.

Each component name must be unique

—even if the components are different types, their names cannot be identical.

What are the rules for naming a variable?

  • Variable names are case-sensitive. …
  • Subsequent characters may be letters, digits, dollar signs, or underscore characters. …
  • If the name you choose consists of only one word, spell that word in all lowercase letters.

What are the rules of naming a file?

  • Files should be named consistently.
  • File names should be short but descriptive (<25 characters) (Briney, 2015)
  • Avoid special characters or spaces in a file name.
  • Use capitals and underscores instead of periods or spaces or slashes.
  • Use date format ISO 8601: YYYYMMDD.

What are poor naming conventions?

  • periods.
  • quotation marks.
  • slashes.
  • question marks.
  • spaces.
  • Anything that is not a letter, number, or underscore.

What is a file naming strategy?

A File Naming Convention (FNC) is

a framework for naming your files in a way that describes what they contain and how they relate to other files

. … These elements could include things like the date of creation, author’s name, project name, name of a section or a sub-section of the project, the version of the file, etc.

Can a file name contain spaces?


Spaces are allowed in long filenames or paths

, which can be up to 255 characters with NTFS. All operations at the command prompt involving long names with spaces, however, must be treated differently. Normally, it is an MS-DOS convention to use a space after a word to specify a parameter.

What are the 4 naming convention tips?

  • Files should be named consistently.
  • File names should be short but descriptive (<25 characters) (Briney, 2015)
  • Avoid special characters or spaces in a file name.
  • Use capitals and underscores instead of periods or spaces or slashes.
  • Use date format ISO 8601: YYYYMMDD.
  • Include a version number (Creamer et al.

Why is it important to use a file naming convention?

A file naming convention is a framework for naming your files in a way that describes what they contain and how they relate to other files. File naming conventions

help you stay organized and makes it easier to identify your files

. By consistently organizing your files, you will be able to quickly find what you need.

What does a naming convention do?

A naming convention is a convention (generally agreed scheme)

for naming things

. Conventions differ in their intents, which may include to: Allow useful information to be deduced from the names based on regularities. … Show relationships, and in most personal naming conventions.

What are the six rules of writing variables?


The first character must be a letter or an underscore

(_). You can’t use a number as the first character. The rest of the variable name can include any letter, any number, or the underscore. You can’t use any other characters, including spaces, symbols, and punctuation marks.

What is not allowed in a variable name?

No other characters are permitted in the variable name. Specifically,

spaces

are not permitted in the variable names, as variable name must be a single word. Variable name may not start with a digit or underscore, and may not end with an underscore. Double underscores are not permitted in variable name.

What are the rules for naming an array?

  • The data type can be any valid data type such as int, float, char structure or union.
  • The name of an array must follow naming rules of variables .
  • the size of the array must be zero or a constant positive integer..
David Martineau
Author
David Martineau
David is an interior designer and home improvement expert. With a degree in architecture, David has worked on various renovation projects and has written for several home and garden publications. David's expertise in decorating, renovation, and repair will help you create your dream home.