Notepad++ Lua带命名空间函数参数提示失效问题求助

我之前也碰到过Notepad++ Lua自动补全里这个头疼的问题——无命名空间的函数（比如collectgarbage、select）参数提示正常，但像math.cos、table.insert这种带.的命名空间函数就是弹不出参数提示，哪怕lua.xml里明明有定义，设置也都开了。折腾了好一会儿，终于找到几个可行的解决办法，还能顺带着实现自定义函数的参数提示，分享给你：

1. 修正lua.xml中的函数定义结构 #

Notepad++的Lua参数提示解析逻辑对带.的函数名支持不好，必须用<Class>标签包裹对应命名空间下的函数，而不是直接在<Function>的name属性里写math.cos这种格式。

举个例子，原来可能是这么写的：

<Function name="math.cos" returnType="number">
  <Param name="x" />
</Function>

你需要改成：

<Class name="math">
  <Function name="cos" returnType="number">
    <Param name="x" />
  </Function>
  <!-- 把所有math库的函数都放在这个Class标签里 -->
  <Function name="sin" returnType="number">
    <Param name="x" />
  </Function>
</Class>

同理，table、string这些库的函数都要放到对应的<Class>标签下，这样Notepad++才能识别出这是某个命名空间下的方法，触发参数提示。

2. 确认additionalWordChar设置正确生效 #

虽然你已经加了.:，但要确保这个属性是写在lua.xml的<Language>标签里的，格式如下：

<Language name="lua" ext="lua" commentLine="--" commentStart="--[[ " commentEnd=" ]]" additionalWordChar=".:">

这个设置是让Notepad++把.和:识别为单词的一部分，这样输入math.的时候才会正确触发该命名空间下的函数补全和参数提示。

3. 实现自定义带命名空间函数的参数提示 #

如果要给你自己的自定义函数（比如my.tools.log）添加参数提示，只需要按照上面的Class结构在lua.xml里添加即可：

<!-- 自定义命名空间my.tools -->
<Class name="my.tools">
  <Function name="log" returnType="void">
    <Param name="content" />
    <Param name="logLevel" default="debug" />
  </Function>
  <Function name="formatString" returnType="string">
    <Param name="template" />
    <Param name="..." />
  </Function>
</Class>

添加完成后，重启Notepad++，输入my.tools.log(的时候就能看到参数提示了。

最后注意事项 #

• 修改lua.xml前一定要备份原文件，避免改错导致自动补全功能失效；
• 所有修改完成后必须重启Notepad++才能生效；
• 如果还是有个别函数不生效，检查一下有没有重复定义的情况（比如同一个函数在多个Class或Function标签里出现），冲突会导致解析异常。

内容的提问来源于stack exchange，提问作者Oscar de Leeuw