FAQ.rar_mathcad_matlabrtwF资源-CSDN文库

共156个文件

htm：154个

pdf：1个

txt：1个

版权申诉

mathcad

59 浏览量 2022-09-14 15:20:44 上传评论收藏 377KB RAR 举报

资源推荐

资源详情

资源评论

收起资源包目录

FAQ.rar_mathcad_matlab rtw F （156个子文件）

00000136.htm 23KB

index.htm 21KB

00000015.htm 12KB

00000020.htm 8KB

00000019.htm 7KB

00000146.htm 5KB

00000135.htm 5KB

00000045.htm 4KB

00000071.htm 4KB

00000001.htm 4KB

00000111.htm 3KB

00000014.htm 3KB

00000037.htm 3KB

00000120.htm 3KB

00000069.htm 3KB

00000016.htm 3KB

00000139.htm 3KB

00000007.htm 3KB

00000011.htm 3KB

00000055.htm 3KB

00000123.htm 2KB

00000057.htm 2KB

00000003.htm 2KB

00000143.htm 2KB

00000044.htm 2KB

00000023.htm 2KB

00000002.htm 2KB

00000043.htm 2KB

00000128.htm 2KB

00000132.htm 2KB

00000141.htm 2KB

00000030.htm 2KB

00000004.htm 2KB

00000013.htm 2KB

00000017.htm 2KB

00000142.htm 2KB

00000116.htm 2KB

00000098.htm 2KB

00000038.htm 2KB

00000072.htm 2KB

00000027.htm 2KB

00000018.htm 2KB

00000008.htm 2KB

00000085.htm 2KB

00000078.htm 2KB

00000000.htm 2KB

00000080.htm 2KB

00000009.htm 2KB

00000104.htm 2KB

00000086.htm 2KB

00000084.htm 2KB

00000127.htm 2KB

00000138.htm 2KB

00000012.htm 2KB

00000119.htm 2KB

00000061.htm 2KB

00000028.htm 2KB

00000010.htm 2KB

00000102.htm 2KB

00000070.htm 2KB

00000046.htm 2KB

00000129.htm 2KB

00000140.htm 2KB

00000131.htm 2KB

00000034.htm 2KB

00000150.htm 2KB

00000103.htm 2KB

00000058.htm 2KB

00000107.htm 2KB

00000126.htm 2KB

00000053.htm 2KB

00000089.htm 2KB

00000105.htm 2KB

00000092.htm 2KB

00000006.htm 2KB

00000065.htm 2KB

00000032.htm 2KB

00000040.htm 2KB

00000039.htm 1KB

00000066.htm 1KB

00000047.htm 1KB

00000134.htm 1KB

00000052.htm 1KB

00000041.htm 1KB

00000048.htm 1KB

00000056.htm 1KB

00000121.htm 1KB

00000130.htm 1KB

00000081.htm 1KB

00000054.htm 1KB

00000063.htm 1KB

00000042.htm 1KB

00000033.htm 1KB

00000149.htm 1KB

00000100.htm 1KB

00000137.htm 1KB

00000112.htm 1KB

00000151.htm 1KB

00000095.htm 1KB

00000021.htm 1KB

共 156 条

MATLAB Programming Style Guidelines

Richard Johnson

Version 1.5 October 2002

“Language is like a cracked kettle on which we beat tunes to dance to, while all the time

we long to move the stars to pity.” Gustave Flaubert, in Madame Bovary

Table of Contents

Introduction.............................................................................................................................................. 2

Naming Conventions ............................................................................................................................. 2

Variables.............................................................................................................................................. 2

Constants.............................................................................................................................................4

Structures ............................................................................................................................................ 4

Functions ............................................................................................................................................. 4

General ................................................................................................................................................ 6

Files and Organization........................................................................................................................... 6

M Files.................................................................................................................................................. 6

Input and Output................................................................................................................................. 7

Statements .............................................................................................................................................. 7

Variables.............................................................................................................................................. 7

Loops.................................................................................................................................................... 8

Conditionals.........................................................................................................................................8

General ................................................................................................................................................ 9

Layout, Comments and Documentation ........................................................................................... 10

Layout ................................................................................................................................................ 10

White Space...................................................................................................................................... 11

Comments ......................................................................................................................................... 12

Documentation.................................................................................................................................. 13

References ............................................................................................................................................ 13

Introduction

Advice on writing MATLAB code usually addresses efficiency concerns, with recommendations such as

“Don’t use loops.” This document is different. Its concerns are correctness, clarity and generality. The

goal of these guidelines is to help produce code that is more likely to be correct, understandable, sharable

and maintainable. As Brian Kernighan writes, “Well-written programs are better than badly-written ones -

- they have fewer errors and are easier to debug and to modify -- so it is important to think about style

from the beginning.”

This document lists MATLAB coding recommendations consistent with best practices in the software

development community. These guidelines are generally the same as those for C, C++ and Java, with

modifications for Matlab features and history. The recommendations are based on guidelines for other

languages collected from a number of sources and on personal experience. These guidelines are written

with M

ATLAB in mind, and they should also be useful for related languages such as Octave, Scilab and

O-Matrix.

Guidelines are not commandments. Their goal is simply to help programmers write well. Many

organizations will have reasons to deviate from them.

“You got to know the rules before you can break ‘em. Otherwise it’s no fun.” Sonny

Crockett in Miami Vice

ATLAB is a registered trademark of The MathWorks, Inc. In this document the acronym TMW refers to

The MathWorks, Inc.

This writeup is dedicated to those who care enough to improve.

Naming Conventions

Patrick Raume, “A rose by any other name confuses the issue.”

Establishing a naming convention for a group of developers can become ridiculously contentious. This

section describes a commonly used convention. It is especially helpful for an individual programmer to

follow a naming convention.

Variables

The names of variables should document their meaning or use.

Variable names should be in mixed case starting with lower case.

This is common practice in the C++ development community. TMW sometimes starts variable

names with upper case, but that usage is commonly reserved for types or structures in other

languages.

linearity, credibleThreat, qualityOfLife

An alternative technique is to use underscore to separate parts of a compound variable name. This

technique, although readable, is not commonly used for variable names in other languages.

Another consideration for using underscore in variable names in legends is that the Tex

interpreter in M

ATLAB will read underscore as a switch to subscript.

Variables with a large scope should have meaningful names. Variables with a small

scope can have short names.

In practice most variables should have meaningful names. The use of short names should be

reserved for conditions where they clarify the structure of the statements. Scratch variables used

for temporary storage or indices can be kept short. A programmer reading such variables should

be able to assume that its value is not used outside a few lines of code. Common scratch variables

for integers are i, j, k, m, n and for doubles x, y and z.

The prefix n should be used for variables representing the number of objects.

This notation is taken from mathematics where it is an established convention for indicating the

number of objects.

nFiles, nSegments

A MATLAB-specific addition is the use of m for number of rows (based on matrix notation), as

mRows

A convention on pluralization should be followed consistently.

A suggested practice is to make all variable names either singular or plural. Having two variables

with names differing only by a final letter s should be avoided. An acceptable alternative for the

plural is to use the suffix Array.

point, pointArray

Variables representing a single entity number can be suffixed by No or prefixed by i.

The No notation is taken from mathematics where it is an established convention for indicating an

entity number.

tableNo, employeeNo

The i

prefix effectively makes the variables named iterators.

iTable, iEmployee

Iterator variables should be named or prefixed with i, j, k etc.

The notation is taken from mathematics where it is an established convention for indicating

iterators.

for iFile = 1:nFiles

end

Note that applications using complex numbers should reserve i, j or both for use as the imaginary

number.

For nested loops the iterator variables should be in alphabetical order.

For nested loops the iterator variables should be helpful names.

for iFile = 1:nFiles

for jPosition = 1:nPositions

end

Negated boolean variable names should be avoided.

A problem arises when such a name is used in conjunction with the logical negation operator as

this results in a double negative. It is not immediately apparent what ~isNotFound means.

Use isFound

Avoid isNotFound

Acronyms, even if normally uppercase, should be mixed or lower case.

Using all uppercase for the base name will give conflicts with the naming conventions given

above. A variable of this type would have to be named dVD, hTML etc. which obviously is not

very readable. When the name is connected to another, the readability is seriously reduced; the

word following the abbreviation does not stand out as it should.

Use html, isUsaSpecific, checkTiffFormat()

Avoid hTML, isUSASpecific, checkTIFFFormat()

Avoid using a keyword or special value name for a variable name.

MATLAB can produce cryptic error messages or strange results if any of its reserved words or

builtin special values is redefined. Reserved words are listed by the command iskeyword. Special

values are listed in the documentation.

Constants

Named constants (including globals) should be all uppercase using underscore to

separate words.

This is common practice in the C++ development community. Although TMW may appear to use

lower case names for constants, for example pi, such builtin constants are actually functions.

MAX_ITERATIONS, COLOR_RED

Constants can be prefixed by a common type name.

This gives additional information on which constants belong together and what concept the

constants represent.

COLOR_RED, COLOR_GREEN, COLOR_BLUE

Structures

Structure names should begin with a capital letter.

This usage is consistent with C++ practice, and it helps to distinguish between structures and

ordinary variables.

The name of the structure is implicit, and need not be included in a fieldname.

Repetition is superfluous in use, as shown in the example.

Use Segment.length

Avoid Segment.segmentLength

Functions

The names of functions should document their use.

Names of functions should be written in lower case.

It is clearest to have the function and its m-file names the same. Using lower case avoids potential

filename problems in mixed operating system environments.

getname(.), computetotalwidth(.)

There are two other function name conventions commonly used. Some people prefer to use

underscores in function names to enhance readability. Others use the naming convention

proposed here for variables.

Functions should have meaningful names.

There is an unfortunate MATLAB tradition of using short and often somewhat cryptic function

names—probably due to the DOS 8 character limit. This concern is no longer relevant and the

tradition should usually be avoided to improve readability.

Use computetotalwidth()

Avoid compwid()

An exception is the use of abbreviations or acronyms widely used in mathematics.

max(.), gcd(.)

Functions with such short names should always have the complete words in the first header

comment line for clarity and to support lookfor searches.

Functions with a single output can be named for the output.

This is common practice in TMW code.

mean(.), standarderror(.)

Functions with no output argument or which only return a handle should be named after

what they do.

This practice increases readability, making it clear what the function should ( and possibly should

not) do. This makes it easier to keep the code clean of unintended side effects.

plot(.)

The prefixes get/set should generally be reserved for accessing an object or property.

General practice of TMW and common practice in C++ and Java development. A plausible

exception is the use of set for logical set operations.

getobj(.); setappdata(.)

The prefix compute can be used in methods where something is computed.

Consistent use of the term enhances readability. Give the reader the immediate clue that this is a

potentially complex or time consuming operation.

computweightedaverage(); computespread()

The prefix find can be used in methods where something is looked up.

Give the reader the immediate clue that this is a simple look up method with a minimum of

computations involved. Consistent use of the term enhances readability and it is a good substitute

for get.

findoldestrecord(.); findheaviestelement(.);

The prefix initialize can be used where an object or a concept is established.

The American initialize should be preferred over the British initialise. Abbreviation init should be

avoided.

initializeproblemstate(.);

The prefix is should be used for boolean functions.

Common practice in TMW code as well as C++ and Java.

isoverpriced(.); iscomplete(.)

There are a few alternatives to the is prefix that fit better in some situations. These include the

has, can and should prefixes:

hasLicense(.); canEvaluate(.); shouldSort(.);

Complement names should be used for complement operations.

Reduce complexity by symmetry.

评论收藏

内容反馈

版权申诉

JonSco

粉丝: 75
资源: 1万+

FAQ.rar_mathcad_matlab rtw F

c2812iqsinetest_c2000_rtw.rar_c2000 matlab

boost_pi_control_loop_design.rar_boost mathcad_boost pi_boost闭环

lc.rar_LC_LC.rar_mathcad_线圈

mathcad-for-FFT-analyzer.rar_mathcad_mathcad FFT_mathcad 谐波_谐波分量

gh.rar_mathcad_mathcad example

Mathcad2000.rar_mathcad_mathcad2000_多元线性_多元线性回归

buck-compensation_mathcad.rar_buck 计算_mathcad环路补偿_mathcad计算环路_环

FlybackDesign.rar_MAthcad design_反激mathcad_反激电源_反激设计_电源 mathcad

buck-mathcad-bode.rar_MATHCAD BODE_bode_buck mathcad_buck 计算_

var3.rar_mathcad

Power-transformer-design.rar_mathcad power_反激 MATHCAD_变压器设计_正激_正

vco.rar_MathCAD源码

G1FERMAT.rar_mathcad

2Mathcad2000.rar_mathcad2000

VSWR.rar_Mathcad 电路_vswr

Mathcad14-User-Guide.rar_mathcad14

FFT-Analysis.rar_FFT分析_fft mathcad_mathcad_mathcad FFT_mathcad i

abc.rar_ABC_mathcad_mathcad 三相_两轴

buck-compensation_mathcad.rar_BUCK补偿_MathCAD 补偿_buck_mathcad环路_环

BBO.rar_BBO_mathcad

冰河的渗透实战笔记-冰河.pdf

大灰狼远控2021最新版，解压密码222

J-LINK V10 V11固件.rar

ISO21434.pdf

Web安全漏洞扫描工具-AWVS14

stm32f103 adc采样+dma传输+fft处理 频率计_fft处理_stm32_ADCFFT_频率计_ADC采样_

CTF 竞赛入门指南（ctf-all-in-one）.pdf

Web中间件常见漏洞总结.pdf

jts-1.14.zip

最新资源

stm32f103 adc采样+dma传输+fft处理频率计_fft处理_stm32_ADCFFT_频率计_ADC采样_