当前位置: 首页 > article >正文

matlab代码规范(自用)

在编写代码的时候,越发觉得一个好的代码需要良好的可读性,在github上看到了别人的代码,写得很规整,觉得很有启发,总结一下。

函数:

  • 在前面说清楚函数的作用,输入输出的接口含义,例如
function g = func(k)
% func creates a relationship betwween angle and transformation matrices (formed by vector)
%
%   EXAMPLE
%       g = func(k)
%       creates a relationship betwween g and k
%
%   INPUT: input parameters
%       k (nx1): curve angle
%
%   OUTPUT:  output parameters
%       g (n,16):  curve with n 4x4 transformation matrices reshaped into nxn vector (columnwise)
%
%   Author: xxx
%   Date: 2022/02/16
%   Version: 0.1
  • 在前面写清楚每个变量的大小和参数类型以及含义
arguments
        k(1,:) double %curve angle
end

另外可选参数也可以用arguments很方便的定义:

比如函数中有option选项,

function [fig] = draw_ctcr(g,tube_end,r_tube,options)

在arguments定义option,可以定义默认值:

在这里插入图片描述
在后面进行option的判断

在这里插入图片描述
调用函数直接调用。
在这里插入图片描述

  • 大的版块用两个百分号注释,大板块下的小模块用一个百分号注释。

比如这样

在这里插入图片描述

  • 画图先初始化,figure,axis,hold on放在画图前面。

  • 参数的初始化也放在最前面。

暂时想到这些,有其他的再记录吧。


http://www.kler.cn/a/2952.html

相关文章:

  • Attention--人工智能领域的核心技术
  • Ansible自动化运维实战--fetch、cron和group模块(5/8)
  • 蓝桥备赛指南(5)
  • 使用langchain ollama gradio搭建一个本地基于deepseek r1的RAG问答系统
  • vim操作简要记录
  • ChatGPT与GPT的区别与联系
  • 动态规划专题(明天继续)
  • 4万字企业数字化转型大数据湖项目建设和运营综合解决方案WORD
  • 谈谈低代码的安全问题,一文全给你解决喽
  • 美国Linux服务器系统增强安全的配置
  • JVM学习.03 类加载机制
  • 力扣-银行账户概要 II
  • C语言——动态内存管理 malloc、calloc、realloc、free的使用
  • WPF WPF布局元素
  • 百万级 Excel导入数据库 效率太低? 基于 SAX 的事件模型 导入,将会解决 效率问题
  • 【Linux】基于阻塞队列的生产者消费者模型
  • Qt音视频开发22-音频播放QAudioOutput
  • 【亲测搭建成功】模拟无网络情况下安装K8S集群和相关组件
  • 导航雷达回波信号格式和目标检测算法
  • 走进Vue【三】vue-router详解
  • java多线程之线程安全(重点,难点)
  • 什么是黄金现货市场
  • 【算法】前缀和
  • 解决win10任何程序打开链接仍然为老旧IE的顽固问题[修改默认浏览器]
  • 重构类关系-Pull Up Constructor Body构造函数本体上移三
  • 2023年通过CDGA的朋友可以考CDGP数据治理专家认证啦!