OBKoro1 / koro1FileHeader

VSCode插件:自动生成,自动更新VSCode文件头部注释, 自动生成函数注释并支持提取函数参数,支持所有主流语言,文档齐全,使用简单,配置灵活方便,持续维护多年。
MIT License
5.64k stars 274 forks source link

matlab注释支持 #194

Closed lingr7 closed 4 years ago

lingr7 commented 4 years ago

想要支持新的语言:

语言:Matlab

提供你最终想要的注释模板: 脚本文件头部

% 5g ldpc encoding
% input: s, bit sequence of dimension K * 1
% output: encoded_bits, bit sequence
% reference: 3GPP TS 38.212 section 5.3.2
% author: Xiao, Shaoning 萧少宁
% license: MIT

一个文件有多个函数,那么单个函数下注释如下

function [H] = alist2sparse(fname) 
% reads binary parity check matrix in "alist" format from file FNAME and 
% converts it to sparse matrix used in MATLAB routines. 
% This is an interface to matrices at http://wol.ra.phy.cam.ac.uk/mackay/codes/ 
% 
% Example 
%        [H] = alist2sparse('A');   % A is the ascii file in alist format 

%   Copyright (c) 1999 by Igor Kozintsev igor@ifp.uiuc.edu 
%   $Revision: 1.1 $  $Date: 2000/03/23 $ Bug fixed by Hatim Behairy 

您的特性请求是否与问题相关?请描述

清楚而简明地描述问题所在,当...使用matlab时,常常一个函数就写成一个脚本文件,所以对一个脚本文件的注释往往就是对这个函数的注释。 描述一下你想要的解决方案. 在文件头部按下快捷键,生成即可

描述你考虑过的备选方案 采用matlab自带的多行注释功能

采用matlab块注释方法 %{ 需要注释的若干语句 %} 其他相关

OBKoro1 commented 4 years ago

 搜了一下,Matlab大概有两种文件test.mtest.mat.m文件会被vscode识别为objective-c语言,.mat则识别不出语言,说明vscode当前不支持Matlab并且跟ios有冲突。所以插件不准备支持Matlab。 你可以使用自定义语言注释,来解决这个问题。