add some comments for key limitation (#17122)

2017-01-09 09:27:38 +08:00 · 2017-01-09 09:27:38 +08:00 · 4574896dbb
parent eb730c10ec
commit 4574896dbb
1 changed files with 3 additions and 0 deletions
--- a/cocos/base/CCUserDefault.h
+++ b/cocos/base/CCUserDefault.h
@ -43,6 +43,9 @@ NS_CC_BEGIN
 * 
 * It supports the following base types:
 * bool, int, float, double, string
+ *
+ * @warning: On windows, linux, use XML to store data, which means there are some limitations of
+ * the key string, for example, `/` is not valid.
 */
 class CC_DLL UserDefault
 {