Scribd Logo
Upload

Welcome to Scribd!

  • 10 views

    2865-1675169569670-U11 - 3.2 Best Practice For Coding

    Uploaded by

    Isuru V. Samarasinghe
    The document discusses best practices for coding including: 1. Following best coding practices improves workflow, reduces costs, and increases security and reliability. 2. Elements should be named clearly using conventions like camel case and pascal case. 3. Code should be properly indented and spaced for readability, with comments on the same indentation level. Methods should be small, have descriptive names, and perform a single task. Long methods should be refactored and method names should clearly indicate their purpose.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content

    You might also like

    2865-1675169569670-U11 - 3.2 Best Practice For Coding

    Uploaded by

    Isuru V. Samarasinghe
    10 views15 pages
    The document discusses best practices for coding including: 1. Following best coding practices improves workflow, reduces costs, and increases security and reliability. 2. Elements should be named clearly using conventions like camel case and pascal case. 3. Code should be properly indented and spaced for readability, with comments on the same indentation level. Methods should be small, have descriptive names, and perform a single task. Long methods should be refactored and method names should clearly indicate their purpose.

    Original Description:

    Original Title

    2865-1675169569670-U11_3.2 Best Practice for coding

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    The document discusses best practices for coding including: 1. Following best coding practices improves workflow, reduces costs, and increases security and reliability. 2. Elements should be named clearly using conventions like camel case and pascal case. 3. Code should be properly indented and spaced for readability, with comments on the same indentation level. Methods should be small, have descriptive names, and perform a single task. Long methods should be refactored and method names should clearly indicate their purpose.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as pdf or txt
    10 views15 pages

    2865-1675169569670-U11 - 3.2 Best Practice For Coding

    Uploaded by

    Isuru V. Samarasinghe
    The document discusses best practices for coding including: 1. Following best coding practices improves workflow, reduces costs, and increases security and reliability. 2. Elements should be named clearly using conventions like camel case and pascal case. 3. Code should be properly indented and spaced for readability, with comments on the same indentation level. Methods should be small, have descriptive names, and perform a single task. Long methods should be refactored and method names should clearly indicate their purpose.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as pdf or txt
    of 15

    Best practice for coding

    Slide No : 3.2
    Content
    • Why is best coding practices being important
    • Name things well
    • Indentation and spacing
    • Avoid writing very long methods
    • Method name should tell what it does.
    • A method should do only one job
    • Comments
    •Why is best coding practices being
    important

    • To develop reliable and maintainable applications, you


    must follow best coding practices.
    • Benefits of using good practices
    • Improve Workflow
    • Reduce Cost
    • Less risks, More security
    Name things well
    • Names are everywhere in software. We name variables, methods,
    classes, functions, source files etc..
    • Naming Conventions
    • Examples –
    • Camel case
    • Pascal case
    Camel case
    • The first character of all words, except the first word, is upper
    case and other characters are lower case.
    • Example:-
    • helloWorld
    Pascal case
    • First character of all word is in upper case and other characters are in
    lower case.
    Example: HelloWorld
    Indentation and spacing
    • 1. Use Tab for indentation. Do not use SPACES.
    • Comments should be in the same level as the code
    A class should not be connected with too
    many other classes.
    Methods

    • Should be very small (20-30 lines max, not more than 1 screen)
    • Use Descriptive names
    • Do one thing
    Avoid writing very long methods

    • A method should typically have 1-50 lines of code. If a method has


    more than 50 lines of cod, you must consider re factoring into
    separate methods.
    Method name should tell what it does.
    • Good
    Void SavePhoneNumber (string PhoneNumber)
    {
    // Save the phone number.
    }
    • Not Good
    // This method will save the phone number.
    Void SaveDetails (string PhoneNumber)
    {
    // Save the phone number.
    }
    A method should do only one job
    • A method should do only ‘one job’. Do not combine more than one
    job in a single method, even if those jobs are very small.
    • Good
    • Not Good
    Comments
    Good and meaningful comments make code more
    maintainable. However,
    Do not write comments for every line code and every
    variable declared.
    Use // or /// for comments. Avoid using /*…*/ or
    “flowerbox ” comment blocks
    Thank You!

    You might also like