pre-commit-matlab

一组pre-commit钩子，用于MATLAB

好的... 目前只有一个钩子，但也许有一天会有更多 😃

使用pre-commit-matlab与pre-commit结合使用

将其添加到您的.pre-commit-config.yaml

-   repo: https://github.com/sco1/pre-commit-matlab
    rev: v1.2.0
    hooks:
    -   id: matlab-reflow-comments
        args: [--line-length=100]

钩子

matlab-reflow-comments

将MATLAB文件（*.m）中的内联注释（以%开头的行）或块注释（由%{和%}分隔）重排到指定的行长度。

空白注释行将传递回重格式化的源代码。

• 使用--line-length指定行长度。（默认：75）
• 使用--reflow-block-comments来控制块注释重排。（默认：True）
• 使用--ignore-indented来忽略具有内部缩进的注释。（默认：True）
  • 注意：此逻辑 不 应用于块注释的内容。
• 使用--alternate-capital-handling将首字母大写的注释行视为新注释块的开始。（默认：False）
  • 注意：此逻辑 不 应用于块注释的内容。

如果ignore-indented为True，则包含至少两个空格的内部缩进的注释将按原样传递回重格式化的源代码。行首的空白字符不考虑。

例如

    % This is not indented
% This is not indented
%  This is indented
%    This is indented

如果 alternate-capital-handling 设置为 True，如果行缓冲区有内容，则以大写字母开头的行将被视为新的注释块的开始。

例如

% This is a comment line
% This is a second comment line that will not be reflowed into the previous line

注意：作为一个有偏见的标志，这可能会导致误报，因此默认情况下是关闭的。如果启用，请仔细关注生成的差异，以确保您的注释按预期重新排列。