vscode之软著代码格式整理

0 背景

在写软著时，对代码格式有一定的要求，具体包括如下（引自《软件著作权提交源代码格式要求》）：

1.代码语法要求

对软件著作权提交源代码是提供原始的代码（不是关键代码）语法上要求代码具备完整性。而且要求提交者提供的源代码是对应的代码文件的最原始文本信息。

例如：C++代码应该是以include之类作为开头，而不能以函数开头；

C#代码应该是using之类作为开头，而不能以函数开头；

2.首页要求

对软件著作权提交源代码的首页应该具备以下至少一种情况所在的页面的原始代码；

a.主函数

b.程序的入口（比如登录函数）

c.主页（比如index default页面）

3.避免因素

对软件著作权提交的源代码尽量少提供或者不提供设计器生成的代码；

例如：以C#语言设计器生成的代码语言文件一般为XXXt.designer.cs

4.提交数量要求

对软件著作权申请都要提供软件60页的源代码，超出60页的应至少提交最前和最后的各连续30页源程序文本，不足60页的，应当将所有的源程序文本全部提交，程序要有比较鲜明的开始段落和结尾的段落，还注意去掉一些注释性的内容。

例如： 要求是50行一页，如果你的源程序文件有59页，那就要提交全部的文件，即59页；如果你的源程序文件有个100页，那只需要提交前30页和最后的30页（70-100页），当中的不用提交。

5.程序数量要求

对软件著作权提交源代码的源程序要求每页有50行程序代码,并要求前30页是程序的前半部分有开头并具有连续性,后30页是程序的后半部分包括结尾也要具有连续性。30和31页之间可以不连续。

6.注意事项

源程序和文档都应当在页眉上标注相应的软件名称和版本号，在每页的右上角通过电脑以阿拉伯数字连续标注页码。除第60页外，每页不能出现只有半页代码的情况。

小结：代码中不能有空行，尽量没有注释，每页代码不少于50行（最后一页除外）

Tips：在word中设置行距为固定值 13.7 磅，每页代码即为 50 行，也可以在布局中打开行号显示

1 删除注释

我们的代码可以用vscode打开，对格式进行批量处理

1.ctrl+h快速打开替换界面，在Find界面输入//[\s\S]*?\n（单行注释//，其余参考下边）

2.Alt+R选择Use Regular Expression(Alt+R)即正则表达式模式：

3.选择Replace All(Ctrl+Alt+Enter)批量替换全部完成操作 

 1.1 c/c++注释

（引自《VScode快速删除注释》）

单行注释（//）：//[\s\S]*?\n

多行注释（/* */）：/\*(.|\r\n|\n)*?\*/

所有注释：\/\*[\s\S]*\*\/|\/\/.*

1.2 python注释

单行注释（#）：将#[\s\S]*?\n替换为\n（否则会影响缩进格式），然后再用上边的方法替换掉空行

多行注释（'''  '''）:将'''(.|\r\n|\n)*?'''或者"""(.|\r\n|\n)*?"""替换为空

2 删除空行

删除空行的方法如下

1.ctrl+h快速打开替换界面，在Find界面输入^\s*(?=\r?$)\n

2.Alt+R选择Use Regular Expression(Alt+R)即正则表达式模式：

3.选择Replace All(Ctrl+Alt+Enter)批量替换全部完成操作 

3 word整理

经过上述方法对代码整理后，就可以复制到word中，word有一些其他需要注意事项：

• 文档的页眉及页码的设置：（字号用5号） 此文档的页眉填加“软件著作权的全称+版本号”和页码（右上角）。
• 文档首页设置与编辑：文字竖排：先“插入文本框”，再录入文字“*软件源程序”。选择“竖排”文字格式，调整字号，调整文本框到页面合适的位置。
• 提示：文档的页眉上，尽量要用软件全称且含版本号。 目的：如果你的软件简称出现问题时，源代码文档不受任何影响！