Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Type and method names are usually not abbreviated (except for the well-accepted abbreviations such as EOFImplFifo, etc.). 

Abbreviation applies to local variables, method parameters, class fields and in some cases public static fileds (constants) of the class.

Variable name should be abbreviated using table below containing mapping between longer name and its short form.

RULE 1 
The variable name should be as short as possible yet to be descriptive enough in a given context.

...

There is a simple custom plugin available that performs on-the-fly check of variable names and highlights incorrectly named variables. Will be added soon..

Plugin can be downloaded from wiki: ignite-abbrev-plugin-3.0.1.jar

Source code of plugin can be found at GitHub ignite-abbrev-plugin

Installation

To install plugin to idea you can do the following steps:

1. Go to 'Settings', and to 'Plugins' section.

2. Select 'Install Plugin From Disk' and select jar from local file system.

'Apache Ignite abbreviation plugin' should appear. After Idea restart abbreviations will be highlited by editor.

Image Added

Anchor
vars
vars

Variable Abbreviation

...

In some rare cases one-letter names can be augmented by number like in common nested catch clause example: e, e1, e2.

Widely used names in the project including specific domain area terms are summarised in the table below. It is required to use abbreviated form for code consistency.

sz

Name

Abbreviation

addressaddr
administrationaffinityadminaff
argumentarg
arrayarr

attachment

attach

attributes

attrs

buffer

buf

certificate

cert

callable

call, c

char

c

attribute(s)attr(s)
bufferbuf

channel

ch; DO NOT USE chnl
classclsclosure

c, clo, f (from function)

collection

col, c

commandcmd

communication

comm

comparator

comp

condition

cond

configcfg
contextctx

control

ctrl

coordinator

crd

copy

cp

counter

cntr
countcnt
currentcurr, cur
databasedbdeclar{e|ation}

decl

defaultdflt

delete

del

delimiter

delim

description

desc

descriptor

descr

destinationdest
directorydir
eventevt
exceptione, e2, ex
executeexec

expected

exp

externalizable

ext
frequencyfreq
futurefut
groupgrp
handlerhnd
headerhdr
implementationimpl
indexidx
initial(ize)init

int

i

interface

itf
iteratoriter

listener

lsnr

lablelabellbl

license

lic
local

loc

localeloc
loggerlog
loaderldr
managermgr
messagemsg

method

mtd

microkernel

mk

milliseconds

ms

multicast

mcast
mutexmux
networknetnumber

n, num

objectobj
packagepkg
parameterparam

permission(s)

perm(s)

passwordpwd

pattern

ptrn
policyplc

predicate

pred

priority

pri

projection(s)

prj(s)

property(ies)prop(s)protocol

proto

process, processorproc
queryqry
receivercv

recipient

rcpt
referenceref
regular expressionregex

remove,removed

rmv

rename

ren

repositoryrepo
requestreq
resourcersrc
responseres
return valueretvalretVal
send, sendersnd

serializable

ser
servicesrvc
sessionses
sequenceseq

sibling

sib

size
socketsock
sourcesrc

specification

spec

strategy

stgy
strings, str
subjectsubj
systemsys

table

tbl

taxonomy

tax

timestamp

ts
topologytop

token

tok

topology versiontopVer

unicast

ucast
valueval
versionver

windows

win