mgkuhn / Naming

Best Practices: choosing and using names

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Choosing and Using Names

  • The first time you see the function facers(x), would you know what it does? (not likely).
  • The first time you see facial_recognition(x), would you know what it does? (very likely).

It is easier to understand what facial_recognition does than it is to understand what facer does.
These brief guides collect information on best practices and sound approaches using names with Julia.

Using good naming practices and choosing names that clarify your intent makes your software better:
easier to maintain, nicer for others to use and peruse, and it smooths later collaborative work.

practice

Naming Guide

examples

Packages and Modules

Types

Functions

Variables

Iteration and Comprehensions

specifics

Short Forms


ask a question
raise an issue

About

Best Practices: choosing and using names

License:MIT License