| 1 | /* $Id: ValidationKitCodingGuidelines.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VirtualBox Validation Kit - Coding Guidelines.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2010-2023 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * The contents of this file may alternatively be used under the terms
|
|---|
| 26 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 28 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 29 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 30 | *
|
|---|
| 31 | * You may elect to license modified versions of this file under the
|
|---|
| 32 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 33 | *
|
|---|
| 34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | /** @page pg_validationkit_guideline Validation Kit Coding Guidelines
|
|---|
| 39 | *
|
|---|
| 40 | * The guidelines extends the VBox coding guidelines (@ref pg_vbox_guideline)
|
|---|
| 41 | * and currently only defines python prefixes and linting.
|
|---|
| 42 | *
|
|---|
| 43 | *
|
|---|
| 44 | * @section sec_validationkit_guideline_python Python
|
|---|
| 45 | *
|
|---|
| 46 | * Python is a typeless language so using prefixes to indicate the intended
|
|---|
| 47 | * type of a variable or attribute can be very helpful.
|
|---|
| 48 | *
|
|---|
| 49 | * Type prefixes:
|
|---|
| 50 | * - 'b' for byte (octect).
|
|---|
| 51 | * - 'ch' for a single character.
|
|---|
| 52 | * - 'f' for boolean and flags.
|
|---|
| 53 | * - 'fn' for function or method references.
|
|---|
| 54 | * - 'fp' for floating point values.
|
|---|
| 55 | * - 'i' for integers.
|
|---|
| 56 | * - 'l' for long integers.
|
|---|
| 57 | * - 'o' for objects, structures and anything with attributes that doesn't
|
|---|
| 58 | * match any of the other type prefixes.
|
|---|
| 59 | * - 'r' for a range or xrange.
|
|---|
| 60 | * - 's' for a string (can be unicode).
|
|---|
| 61 | * - 'su' for a unicode string when the distinction is important.
|
|---|
| 62 | *
|
|---|
| 63 | * Collection qualifiers:
|
|---|
| 64 | * - 'a' for a list or an array.
|
|---|
| 65 | * - 'd' for a dictionary.
|
|---|
| 66 | * - 'h' for a set (hashed).
|
|---|
| 67 | * - 't' for a tuple.
|
|---|
| 68 | *
|
|---|
| 69 | * Other qualifiers:
|
|---|
| 70 | * - 'c' for a count. Implies integer or long integer type. Higest
|
|---|
| 71 | * priority.
|
|---|
| 72 | * - 'sec' for a second value. Implies long integer type.
|
|---|
| 73 | * - 'ms' for a millisecond value. Implies long integer type.
|
|---|
| 74 | * - 'us' for a microsecond value. Implies long integer type.
|
|---|
| 75 | * - 'ns' for a nanosecond value. Implies long integer type.
|
|---|
| 76 | *
|
|---|
| 77 | * The 'ms', 'us', 'ns' and 'se' qualifiers can be capitalized when prefixed by
|
|---|
| 78 | * 'c', e.g. cMsElapsed. While this technically means they are no longer a
|
|---|
| 79 | * prefix, it's easier to read and everyone understands what it means.
|
|---|
| 80 | *
|
|---|
| 81 | * The type collection qualifiers comes first, then the other qualifiers and
|
|---|
| 82 | * finally the type qualifier.
|
|---|
| 83 | *
|
|---|
| 84 | * Python statements are terminated by semicolons (';') as a convention.
|
|---|
| 85 | *
|
|---|
| 86 | */
|
|---|
| 87 |
|
|---|
