2016-09-27 1 views
1

Lua開発ツールでは、入力パラメータがある種のテーブルであることをどのように文書化しますか?入力パラメータがLua開発ツールで何らかのタイプのテーブルであることを文書化するにはどうすればよいですか?

mynamespace = {} 

--- 
-- @type mynamespace.MyClass 
-- @field #number var1 
mynamespace.MyClass = {} 

--- 
-- @param #number param1 
-- @return #mynamespace.MyClass 
function mynamespace.MyClass.new(param1) 
    local self = mynamespace.MyClass 
    self.var1 = param1 
    return self 
end 


--- 
-- @param WHAT_DO_I_WRITE_HERE arrayOfMyClass 
function processArrayOfMyClass(arrayOfMyClass) 
    for i=1, #arrayOfMyClass do 
     instanceOfMyClass = arrayOfMyClass[i] 
     -- ... do something with an element of the array 
    end 
end 

EDIT:申し訳ありません。このドキュメントはLDT(Lua Development Tools)を除いたものと思われます。私の質問を更新します

+0

を ' - @param arrayOfMyClassそれはいくつかのsort.' [ドキュメント]の表である(https://keplerproject.github.io/luadoc /manual.html#tags) – Green

+0

そのコメントを詳しく教えてください。 – gromit190

+1

'@param 'あなたはテーブルを記述するだけです。 '@param'とparamの間には何も置かれません。私はluadocリファレンスで '#'を見つけることができません。 '#number 'にはどんな効果がありますか? – Piglet

答えて

1

私は[email protected] #list<#bajas.ReinforcementSetup> reinforcementSetupsを使用して終了しました、魅力的な作品です!

は、ここでは、LDTのドキュメントでそれを見つけた:https://wiki.eclipse.org/LDT/User_Area/Documentation_Language#Structure_types

mynamespace = {} 

--- 
-- @type mynamespace.MyClass 
-- @field #number var1 
mynamespace.MyClass = {} 

--- 
-- @param #number param1 
-- @return #mynamespace.MyClass 
function mynamespace.MyClass.new(param1) 
    local self = mynamespace.MyClass 
    self.var1 = param1 
    return self 
end 


--- 
-- @param #list<#mynamespace.MyClass> arrayOfMyClass 
function processArrayOfMyClass(arrayOfMyClass) 
    for i=1, #arrayOfMyClass do 
     instanceOfMyClass = arrayOfMyClass[i] 
     -- ... do something with an element of the array 
    end 
end 
0

type(val)を使用して、渡されるデータの種類を確認し、効果的なエラーメッセージを返してコーダーに間違いを説明することができます。

+0

"入力パラメータはLuaのある種のテーブルですか?ランタイムエラーはドキュメンテーションではありません。 – Oka

+1

いいえ、それと協力して使用する必要があります。書類作成は簡単です。あなたはコメントをする必要があります:P @oka – warspyking

関連する問題