{"id":4987,"date":"2019-10-18T18:19:17","date_gmt":"2019-10-18T07:19:17","guid":{"rendered":"https:\/\/casestudyhelp.com\/sample-questions\/?p=4987"},"modified":"2019-10-18T18:19:17","modified_gmt":"2019-10-18T07:19:17","slug":"ict112-doc-style-basic-guide-for-documentation-and-coding-style-in-2019","status":"publish","type":"post","link":"https:\/\/casestudyhelp.com\/sample-questions\/ict112-doc-style-basic-guide-for-documentation-and-coding-style-in-2019\/","title":{"rendered":"ICT112 Doc Style: Basic Guide for Documentation and Coding Style in 2019"},"content":{"rendered":"
\n

Are You Looking for ICT112 Doc Style for Documentation and Coding Style in 2019? This is a basic guide for documentation and coding style for ICT112 2019, note that it is based on the Official Python Style. Get case study answers<\/strong><\/a> to questions in ICT112 Pythong Programming Assignment Help<\/strong><\/a>, ICT112 Doc Style or Code Style from programming experts<\/strong><\/a> online in Australia, UK and USA.<\/p>\n<\/blockquote>\n

 <\/p>\n

\"Order-now\"<\/a><\/p>\n

ICT112 Code Style<\/strong><\/h2>\n

This is a basic guide for documentation and coding style for ICT112 2019, note that it is based on the Official Python Style: PEP8 (https:\/\/pep8.org\/#naming-<\/span> conventions<\/span>) modified to include Hungarian notation to assist beginner programmers to conceptualize scope and types. For more information on Hungarian notation see http:\/\/codevba.com\/help\/VB_naming_conventions.htm#.XJMDSFMzZTY<\/span><\/p>\n

Outside of the variable naming (which is as above), a good references are: https:\/\/realpython.com\/python-pep8\/<\/span> and https:\/\/realpython.com\/documenting-<\/span> python-code\/<\/span><\/p>\n

NAMING<\/strong><\/h2>\n
    \n
  • Useful names are:\n
      \n
    • Descriptive<\/li>\n
    • Not too long<\/li>\n
    • Not \u201cSTEVE!\u201d<\/li>\n<\/ul>\n<\/li>\n
    • Package names: alllowercase<\/li>\n
    • Module names: alllowercase or all_lower_case<\/li>\n
    • Class names: CapName (sometimes called CamelCase)<\/li>\n
    • Function names: words_separated_by_an_underscore<\/li>\n
    • Variable names: also words_separated_by_an_underscore<\/li>\n<\/ul>\n

      SCOPE<\/strong><\/h2>\n
        \n
      • Internal\/non-public: _variable_name or _function_name<\/li>\n
      • Intended variable Scope:\n
          \n
        • Class level: _cls_var<\/li>\n
        • Module level: _mod_var<\/li>\n
        • Global g_global_var<\/li>\n<\/ul>\n<\/li>\n
        • Constants: g_c_type_GLOBAL_CONSTANT or m_c_type_MODULE_CONSTANT<\/li>\n<\/ul>\n
            \n
          • Types are important: (Not standard Python Style but helps readability)<\/em>\n
              \n
            • Integer: int_number_var<\/li>\n
            • Decimal\/Double: dbl_decimal_var<\/li>\n
            • String: str_string_var<\/li>\n
            • List: lst_list_var<\/li>\n
            • Dictionary: dict_dictionary_var<\/li>\n
            • File: file_file_var<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

              COMMENTS<\/strong><\/h2>\n

              All files must have comments at the start of the file, above every module\/class, above every method, and throughout code as needed for clarity. These comments conform to standard PEP8 – https:\/\/realpython.com\/python-pep8\/<\/span><\/p>\n

              File comments:<\/strong><\/h3>\n
                \n
              • Must name file, author, and purpose of\u00a0file.<\/li>\n
              • If file is executable, must include example\u00a0usage.<\/li>\n<\/ul>\n

                For example:<\/strong><\/p>\n

                \u00a0\u00a0<\/span>author\u00a0 \u00a0<\/span>= “Erica Mealy, Mark Utting, and Adriano da Silva Marinho”<\/p>\n

                \u00a0\u00a0<\/span>version\u00a0 \u00a0<\/span>= “0.0.1”<\/p>\n

                \u00a0\u00a0<\/span>email = “emm042@student.usc.edu.au”<\/p>\n

                “””Example style docstrings.<\/em><\/strong><\/p>\n

                  \n
                • This module demonstrates documentation. Docstrings may extend over multiple lines Sections are created with a section header and a colon followed by a block of indented text.<\/em><\/li>\n<\/ul>\n

                  Example:<\/em><\/strong><\/p>\n

                    \n
                  • Examples can be given using either the “Example“ or “Examples“ sections. Sections support any reStructuredText formatting, including literal blocks::<\/em><\/li>\n<\/ul>\n

                    $ python example_google.py <\/em><\/p>\n

                    Attributes:<\/em><\/strong><\/p>\n

                      \n
                    • module_level_variable1 (int): Module level variables may be documented\u00a0<\/em>in either the “Attributes“ section of the module docstring, or in an inline docstring immediately following the variable.<\/em><\/li>\n<\/ul>\n

                      “””<\/em><\/p>\n

                      Function comments<\/strong><\/h2>\n

                      Every function should have a comment that succinctly explains what it does, the parameter\/s it expects (including type) and the return value.<\/p>\n

                      For example:<\/strong><\/p>\n

                      def <\/strong>ball_height(vel0, time): “””Calculates the height of a ball.<\/p>\n

                      :param vel0: upward initial speed (metres\/sec)<\/p>\n

                      :param time: current time in seconds.<\/p>\n

                      :returns: the height of the ball in metres. “””<\/p>\n

                      up = vel0*time<\/p>\n

                      down = 0.5 * 9.8 * time**2<\/p>\n

                      return <\/strong>up \u2013 down<\/p>\n

                      GENERAL FORMATTING<\/strong><\/h2>\n
                        \n
                      • Indentation is important \u2013 ensure you indenting is correct, especially for if\/else statements where the else is a number of lines below the if statement.<\/li>\n<\/ul>\n
                          \n
                        • Lines should be kept to a reasonable length \u2013 PEP8 says 80 characters wide\n
                            \n
                          • Continue lines sensibly see https:\/\/realpython.com\/python- pep8\/#maximum-line-length-and-line-breaking<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
                              \n
                            • Use spaces NOT<\/span> tabs (note that Jupyter will change uses of the tab key INTO spaces for you)<\/li>\n<\/ul>\n
                                \n
                              • Include spaces around binary operators \u2013 e.g. 1 + 2, NOT<\/span> 1+2<\/li>\n<\/ul>\n
                                  \n
                                • Don\u2019t<\/span> include space before OR after :,(,[, \u2013 e.g.\n
                                    \n
                                  • def fn_name(param):<\/strong>\n
                                      \n
                                    • NOT<\/span> def fn_name(param) :<\/li>\n
                                    • NOT<\/span> def fn_name (param):<\/li>\n
                                    • NOT<\/span> def fn_name( param ):<\/li>\n<\/ul>\n<\/li>\n
                                    • list [3]<\/strong>\n
                                        \n
                                      • NOT<\/span> list [3]<\/li>\n
                                      • NOT<\/span> list[ 3 ]<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
                                          \n
                                        • Use Vertical white space (aka line breaks) to help separate classes and functions from other\u00a0code.<\/li>\n
                                        • Never use l (lower case L), O (capital o) or I (capital i) as variable names as they can easily be mistaken for 1s and 0s<\/li>\n<\/ul>\n