Coding Guidelines

549 views
504 views

Published on

Published in: Technology, Business
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
549
On SlideShare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
8
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

Coding Guidelines

  1. 1. h5SE #ODING 3TANDARDS TO )NCREASE %FFICIENCY AND 0RODUCTIVITYv !DHERING TO A WELL DESIGNED CODING STANDARD CAN GIVE YOUR SOFTWARE DEVELOPMENT AN EDGE #ODING STANDARDS ARE BENIFICIAL FOR EVERYONE INVOLVED ,OTUS #ODING 3TANDARDS SOFTWARE CREATION
  2. 2. MAINTENANCE AND USAGE .O QUESTION ABOUT THAT 4HE HARD s 5SER INTERFACE PART IS GETTING DEVELOPERS TO ADHERE TO IT Y USING THE /PEN.4ORG WIKI FOR s $ESIGN ELEMENTS CODING GUIDELINES EVERY DEVELOPER CAN CONTRIBUTE
  3. 3. ARGUE THE CODING s ORMULA LANGUAGE GUIDELINES 2ESULTING IN THE CODING GUIDELINES BY THE CROWD s ,OTUSSCRIPT s #ODING STYLES
  4. 4. LIKE /0%..4/2' 7)+) #/.#%04 s $ATE4IME HANDLING 0QFO/5' JT B XFCTJUF EFWPUFE UP 5IF #FTU 1SBDUJDF TFDUJPO PO 0QFO/5' s %RROR HANDLING HFUUJOH HSPVQT PG JOEJWJEVBMT BMM PWFS UIF PSH XPSLT BDDPSEJOH UP UIF XJLJ s $OCUMENTATION XPSME UP DPMMBCPSBUF PO -PUVT /PUFT DPODFQU XJLJ JT TPGUXBSF UIBU BMMPXT WWW/PEN.4/RG %PNJOP BQQMJDBUJPOT BOE SFMFBTF UIFN VTFST UP FBTJMZ DSFBUF FEJU BOE MJOL BT PQFO QBHFT UPHFUIFS 8JLJT BSF PGUFO VTFE UP TPVSDF 5IFJS NJTTJPO JT ýUP QSPWJEF B DSFBUF DPMMBCPSBUJWF XFCTJUFT BOE UP h(!6).' #/$).' GSBNFXPSL GPS UIF DPNNVOJUZ UP QPXFS DPNNVOJUZ XFCTJUFT 8JLJT BSF 34!.$!2$3 ). ! EFWFMPQ PQFO TPVSDF BQQMJDBUJPOT GPS VTFE JO NBOZ CVTJOFTTFT UP QSPWJEF *#. -PUVT /PUFT BOE %PNJOP XIJDI BGGPSEBCMF BOE FGGFDUJWF *OUSBOFUT BOE 3/47!2% NBZ CF GSFFMZ EJTUSJCVUFEý $VSSFOUMZ GPS ,OPXMFEHF .BOBHFNFOU XJLJ $%6%,/0-%.4 UIF TJUF IBT HSPXO UP BMNPTU GJGUZ GBDJMJUBUFT UIF XJTEPN PG UIF DSPXE /2'!.):!4)/. (!3 UIPVTBOE SFHJTUFSFE QBSUJDJQBOUT XIP EPXOMPBE UFO UIPVTBOE BQQMJDBUJPOT 7)+) !.$ #-3 !$6!.4!'%3 /2 QFS NPOUI 5IFSF BSF NPSF UIFO $PNQBSFE UP B HFOFSBMJ[FE DPOUFOU $%6%,/0%23
  5. 5. 15!,)49 0QFO/5' 1SPKFDUT XJUI DPEF SFMFBTFT NBOBHFNFOU TZTUFN $.4 BO !3352!.#% 4%!-
  6. 6. BWBJMBCMF 0QFO/5' PGGFST BMTP B $PEF FOUFSQSJTF XJLJ IBT UIFTF CBTJD #JO 8JEHFUT BOE #FTU 1SBDUJDFT GFBUVSFT 02/*%#4 -!.!'%23 5IF OBNF PG BO BSUJDMF JT FNCFEEFE !.$ %.$ 53%23v
  7. 7. #/$).' '5)$%,).%3 %34 02!#4)#%3 JO UIF IZQFSMJOL %34 02!#4)#%3 SUJDMFT DBO CF DSFBUFE PS FEJUFE BU -PUVT /PUFT PSHBOJ[BUJPOT JNQSPWF ENEFITS BOZUJNF CZ BOZPOF XJUI DFSUBJO FGGJDJFODZ BOE QSPEVDUJWJUZ EVSJOH UIF MJNJUBUJPOT GPS QSPUFDUFE BSUJDMFT XIPMF MJGFDZDMF PG BO BQQMJDBUJPO CZ 4HE USE OF CODING STANDARDS RESULTS IN 8FC CSPXTFS CBTFE FEJUJOH PG BEIFSF UP DPEJOH HVJEFMJOFT %VSJOH BENEFITS DURING THE COMPLETE LIFE CYCLE OF BSUJDMFT EFWFMPQNFOU NBJOUFOBODF VTBHF BOE AN APPLICATION BDI BSUJDMF QSPWJEFT POFDMJDL SFUJSJOH PG BQQMJDBUJPOT UIF $ESIGN BDDFTT UP UIF IJTUPSZWFSTJPOJOH QBHF PSHBOJ[BUJPO DBO CFOFGJU GSPN UIPTF s -ODELERS KNOW WHICH FUNCTIONALITY IS XIJDI BMTP TVQQPSUT WFSTJPO CFTU QSBDUJDFT 4FF TJEFCBS GPS B PROVEN EJGGFSFODJOH ýEJGGý BOE SFUSJFWJOH QSJPS OVNCFS PG CFOFGJUT GSPN B MJGFDZDMF UILD WFSTJPOT QPJOU PG WJFX s .EW PROGRAMMERS DONgT HAVE TO 3FDFOU BEEJUJPOTNPEJGJDBUJPOT PG REINVENT THE WHEEL AGAIN BSUJDMFT DBO CF NPOJUPSFE BDUJWFMZ PS !$(%2).' 4/ %34 02!#4)#%3 s %FFICIENCY IN DEVELOPMENT HOURS QBTTJWFMZ 5IF JNQMFNFOUBUJPO BOE BEIFSJOH UP 4EST #FTU 1SBDUJDFT DBO CF BO s #ODING STANDARDS WILL AID THE CREATION !4/3 /2)'). ,/453 PSHBOJ[BUJPOBM DIBMMFOHF TQFDJBMMZ OF AUTOMATED h4EST 3CRIPTSv UPT 0SJHJO IBT B EFEJDBUFE -PUVT EFWFMPQFST NBZ TVGGFS GSPN UIF h/PU 0RODUCTION /PUFT HSPVQ UIBU DPOTJTUT PG *OWFOUFE )FSFhTZOESPNF UPT 0SJHJO s 3OURCE CODE WILL BECOME EASY TQFDJBMJTUT XIJDI IBWF CFFO JOWPMWFE IBT CFFO IFMQJOH PSHBOJ[BUJPOT GPS TOMAINTAIN GSPN UIF FBSMZ EBZT PG /PUFT 5IF ZFBST UP PWFSDPNF UIPTF DIBMMFOHFT s 5NIFORM APPROACH CODING WILL RESULT IN TFSWJDFT UIBU BSF QSPWJEFE DPOUBJO TVDDFTTGVMMZ $POUBDU UPT 0SJHJO GPS A MORE CONSISTENT END USER DPOTVMUJOH BSDIJUFDUVSF EFTJHO BEWJTJOH ZPV PO ZPVS TVDDFTTGVM EXPERIENCE JNQMFNFOUBUJPO NBOBHFNFOU BOE JNQMFNFOUBUJPO PG DPEJOH TUBOEBSET 2ETIREMENT NBJOUFOBODF PG -PUVT BOE 8FC4QIFSF 3FTVMUT PG TBWJOHT QFS ZFBS BSF s -ONITOR APPLICATION USAGE 1PSUBM BQQMJDBUJPOT NPOH PVS FBTJMZ HVBSBOUFFE DVTUPNFST XF IBWF NVMUJOBUJPOBMT BT XFMM BT 4.# DVTUPNFST -PUVT JT QBSU PG UIF OUFSQSJTF $POUFOU !TOS /RIGIN .BOBHFNFOU $. EPNBJO PG UPT 1BQFOEPSQTFXFH 0SJHJO 8JUIJO UIF $. NBSLFU UPT #+ 653$)5 0SJHJO JT UIF QSPVE MFBEFS PG B 5FM NBSLFU TIBSF JO UIF /FUIFSMBOET XXXOMBUPTPSJHJODPN UPT 0SJHJO QPTTFTTFT BO JOOPWBUJWF TFSWJDF BOE TVQQPSU DFOUFS UIBU SFBMJ[FT DPTU FGGFDUJWF VTBHF BOE NBOBHFNFOU PG -PUVT /PUFT BQQMJDBUJPOT UISPVHI EFEJDBUFE JOQVU NBJOUFOBODF BOE TVQQPSU UPT 0SJHJO USJFT UP QSPWJEF PVS DMJFOUT $PNNVOJDBUJF /- XJUI UIF CFTU TFSWJDFT BWBJMBCMF 8F PQUJNJ[F PVS LOPXMFEHF CZ TIBSJOH JU XJUI UIF PQFO TPVSDF DPNNVOJUZ GPS #FTU 1SBDUJDFT PO DPEJOH HVJEFMJOFT ª .BSLFUJOH Ñ34!24 53).' 4(% #/$).' '5)$%,).%3 /. 777/0%..4/2'Ñ !TOS
  8. 8. !TOS AND FISH SYMBOL
  9. 9. !TOS /RIGIN AND FISH SYMBOL
  10. 10. !TOS #ONSULTING
  11. 11. AND THE FISH SYMBOL ITSELF ARE REGISTERED TRADEMARKS OF !TOS /RIGIN 3!

×